The Model Context Protocol (MCP) is the emerging standard that lets AI assistants use external tools. Obriym ships an MCP server as a thin third boundary over the same shared operations as the Public API — every tool checks your token's scope and the workspace subscription before it runs, and nothing touches the database directly. Point any MCP-aware assistant at it and it works inside your CRM in natural language.
What an assistant can do
Read your whole CRM
search_leads, get_lead, search_contacts, get_contact, search_companies, get_company, search_deals, get_deal, list_activities, get_activity, list_customers, get_customer, list_orders, get_order, search_products, get_product, get_dashboard_overview, get_report, get_workspace_info, list_workspaces.
Take guarded actions
convert_lead, assign_lead, transition_deal, create_order with line items, create/update leads, contacts, companies and deals, create and complete activities, update order status — each gated by the matching :write scope on your token.
Inspect & tune the setup
list_pipeline_stages, list_lead_sources, configure_pipeline and set_lead_sources — the assistant can read your workspace configuration and adjust a pipeline stage or lead source.
Connection
A remote, stateless Streamable HTTP server — nothing to install.
- Endpoint
- https://obriym-crm.com/api/mcp
- Protocol
- Model Context Protocol (Streamable HTTP, stateless)
- Auth
- OAuth 2.1 one-click sign-in, or Authorization: Bearer <your workspace API token>
- Scopes
- the same scopes as the REST API (products, leads, deals, orders, …)
Connect your AI assistant
Add the MCP server to your AI client. Cursor and VS Code install in one click; the rest take the URL above and sign in with OAuth.
MCP server URL
https://obriym-crm.com/api/mcpSign in with your Obriym CRM account — no token or app setup needed.
Cursor
Add to CursorVS Code
Add to VS CodeClaude Code
claude mcp add --transport http obriym-crm https://obriym-crm.com/api/mcpRun in your terminal, then /mcp to sign in.
ChatGPT
Manual- 1Settings → Connectors → Add custom connector (Developer Mode).
- 2Paste the MCP server URL above and choose OAuth.
- 3Sign in with your Obriym CRM account.
Claude (web & desktop)
Manual- 1Settings → Connectors → Add custom connector.
- 2Paste the MCP server URL above.
- 3Sign in with your Obriym CRM account.
Setup
- 1
Sign in or create an API token
For a personal AI client, choose OAuth: Obriym shows the active CRM session, name and email before approval. For server automation, create a scoped Bearer token.
- 2
Add the server to your client
Add the server URL. With OAuth, approve the displayed account or choose “Use another account”; with Bearer, pass the token in the Authorization header.
- 3
Work in natural language
Ask the assistant to find stale leads, summarize a deal, or update an order status — it calls the matching tool for you.
Safe by design
- A per-workspace paid capability — MCP needs a Team or Scale plan. OAuth uses the active CRM session but always shows its name and email and requires explicit approval for a new AI client.
- Multiple workspaces — explicit, no surprises: all CRM data stays blocked until selection; get_workspace_info shows the connected account and workspace, list_workspaces lists available ones, and select_workspace changes it only on your request.
- Revoking access in the Integration Center deletes the access token, refresh token, OAuth consent and workspace binding — reconnecting requires approval again.
- Same permissions as the API — a tool never exceeds your token's scopes.
- Inactive paid workspaces are blocked, exactly like the API.
- Rate-limited per tool; no direct database access — only the shared, audited operations.
- Opt-in per deployment — the endpoint returns 404 until it is enabled.
Frequently asked questions
Which assistants work?
Any MCP-compatible client — Claude (desktop and web), ChatGPT, Gemini, Cursor, and other MCP-aware tools.
Is it the same as the REST API?
It reuses the exact same shared operations, token and scopes as the Public API — MCP is a third protocol boundary over them, not a new data surface.
Do I need to install anything?
No. Add the URL and sign in with OAuth — Obriym shows the active account before approval and lets you switch it. A Bearer token remains available for machine clients.
I have several workspaces — where does the assistant write data?
Into exactly one. With several workspaces the connection starts locked and the assistant must ask you to choose before any data read. get_workspace_info also shows the connected account name and email; list_workspaces and select_workspace let you verify or change the workspace.
Let an AI assistant run your CRM
MCP is included on the Team and Scale plans. Pick a plan, generate a scoped token, and connect Obriym to your favorite MCP client in minutes.
See plans