User Guide

User Guide: ContextLoom Enterprise

Version: 3.1.0 Target Audience: Software Engineers, Team Leads, System Administrators

This guide explains how to use the ContextLoom platform to create governed, high-quality context for your AI agents.

1. Getting Started

1.1 Authentication

ContextLoom supports two methods of authentication:

• Email/Password: Standard login using credentials managed by the appliance.
• Corporate SSO: If your organization has the “Identity Shield” module, you can sign in using your corporate Identity Provider (Okta, Azure AD, etc.) via the “Continue with Corporate SSO” button.

1.2 The Dashboard

Upon logging in, you are greeted by the Dashboard. This is your central hub for context management.

• Bundle List: View all active bundles in your current organization.
• Search: Filter bundles by name or description.
• Quick Actions:
  • Copy ID: Click the clipboard icon on any card to get the cl:// URI for use with AI agents.
  • Delete: Remove obsolete bundles.
• Create Bundle: Click the “New Bundle” button or the large dashed card to start the curation process.

---

2. Managing Context Bundles

The Bundle Curator is the core “IDE” of ContextLoom. It allows you to select files from your repositories and package them with instructions.

2.1 The Source Browser (Left Pane)

This pane connects to your live Version Control System.

1. Repository Selector: Choose which connected repository you want to browse.
2. Branch Selector: Switch between branches (e.g., main, develop, feature-branch).
3. File Tree: Navigate the folder structure.
   • Single File: Click a file to add it to your bundle.
   • Recursive Add: Select a folder to automatically add all compatible source code files within it.

2.2 The Manifest (Right Pane)

This list represents exactly what the AI agent will see.

• Selected Files: A flat list of all files currently in the bundle. You can remove individual files using the trash icon.
• Description: A human-readable summary of the bundle (e.g., “Billing Service - Authentication Module”). This helps your team find the right context.
• System Instruction: A natural language directive (prompt) attached to the bundle.
  • Example: “Act as a Senior Security Engineer. Review the following code for OWASP Top 10 vulnerabilities.”

2.3 Versioning Strategy (Pinning)

At the top right, the Version Mode toggle controls how the content is served:

• Dynamic (Default): The bundle always fetches the latest version (HEAD) from the target branch. Use this for active development where the code changes frequently.
• Pinned (Locked): ContextLoom resolves the current Commit SHA for every file and locks it. Future fetches will always serve this exact version, even if the repo changes.
  • Use Case: Reproducible regression tests, Compliance audits, Production releases.

---

3. Organization Settings

3.1 Connecting Repositories

Navigate to Settings > Repositories.

• GitHub / GitLab: Enter the Owner/Repo (e.g., acme/billing-service) and a Personal Access Token (PAT).
• Local: For on-premise deployments, mapped directories can be added by path (e.g., /data/repos/monorepo).
• Enterprise Server: If using self-managed GitHub/GitLab, you can specify the Base URL.

3.2 Team Management

Navigate to Settings > Team.

• Invite Members: Search for users by email to add them to your organization.
• Roles:
  • VIEWER: Can consume bundles via MCP but cannot edit them.
  • CURATOR: Can create and edit bundles.
  • ADMIN: Can manage repositories and team members.

3.3 Access Tokens (PATs)

To connect your local tools (Claude Desktop, Cursor, JetBrains) to the appliance, you need a Personal Access Token.

1. Navigate to Settings > Personal Access Tokens.
2. Click Generate New Token.
3. Set an expiration (default 30 days) and give it a name (e.g., “My Work Laptop”).
4. Copy the token immediately. It will not be shown again.

---

4. Consuming Context (MCP)

Once a bundle is saved, use it with your AI tools via the Model Context Protocol (MCP).

In Prompt:

“Review the authentication logic. Use context: @ContextLoom/Billing Logic v1”

Or manually using the URI:

“Build-up context using MCP cl://bundles/550e8400-e29b…”

Note: Ensure your local MCP client is configured with the Bridge and your PAT.

---

5. System Administration (Superusers)

Users with the Superuser flag have access to the Admin section in the sidebar.

5.1 User Management

Navigate to Admin > Users.

• View All Users: See a system-wide list of all registered users and their status.
• Promote/Demote: Toggle the “Superuser” status (Shield icon) for other users.
• Deactivate: Soft-delete users to prevent login without destroying data.
• Hard Delete: Permanently remove a user and their personal data.
• Invitations: View and revoke pending system invitations.

5.2 Organization Management

Navigate to Admin > Organizations.

• Create Organization: Manually provision new tenants.
• Domain Whitelist: Configure “Auto-Join” rules. e.g., Set acme.com to automatically add any new user with an @acme.com email to this organization.

5.3 License Management

Navigate to Admin > License.

• View Status: Check your current plan, expiration date, and resource limits (Users, Repos, Bundles).
• Update Key: Paste a new JWT license key to unlock Enterprise modules (SSO, SIEM) or increase limits.