LockMCP Documentation
LockMCP connects your platform's data to AI clients like Claude through a single, governed MCP endpoint — with your own auth, your own roles, and your own APIs behind it.
New here? Read Getting Started, then Core Concepts. Between them you'll have the whole mental model.
Getting Started
- Getting Started — what LockMCP is and the three ways to connect
- Core Concepts — workspace, connection, tool, role, identity model
- Choosing an Identity Model — the decision guide
- Demo Apps, End to End — run one demo app per identity model and call its tools through LockMCP
Onboarding
- Prerequisites — what you need before you start
- Getting Your Workspace — first sign-in
- Workspace Tour — what each dashboard section does
Create a Connection
Overview — the five-step wizard, shared by every identity model. Only Step 3 differs:
Identity Brokering
Fastest path. Users sign in through LockMCP; nothing to configure, and it works with desktop AI clients.
Overview · Configuration · Auth Flow · Troubleshooting
Token Exchange
You already run an identity provider. Register it once and your users keep their existing accounts.
Overview · Configuration · Auth Flow · Troubleshooting
Tenant Delegated
Your app owns the user directory and the login page. The most control, and the most to implement.
Overview · Contract Specification · Environment Setup · Endpoints · HMAC Signing · Session Tokens · Login Page · Troubleshooting
Working with Connections
- Writing OpenAPI Specs — turn your API into tools
- Tool Catalog — publishing
- Tool Studio — authoring and refining tools
- Enum Injection — per-user parameter scoping
- Record Scope — setting the per-user IDs enum injection uses
Members & Access
- Roles and Permissions — what roles control
- Inviting Members — adding people
- Invitations API — inviting people from your own server
- Assigning Tool Access — who can call what
Connecting AI Clients
- AI Clients — Claude Desktop, Cursor, Claude web, ChatGPT
- Programmatic Integration — calling tools from your own service
Operations
- Monitoring & Audit — audit log, metrics, sessions
- Workspace Settings — workspace-wide configuration
- Security — encryption, keys, isolation
Reference
- Troubleshooting — symptom to cause
- FAQ — common questions
- Glossary — terminology