Skip to main content

​
Partner MCP

The partner MCP server lets AI clients — Claude, ChatGPT, Cursor, and other Model Context Protocol clients — work with your partnership’s leads, deals, and more in natural language. It calls the same Partner API endpoints, so the same authentication, scoping, and visibility rules apply.

​
What you can do

A connected client can check who you are and list your partnerships, read and register leads, and read, create, and update deals — including moving them between pipeline stages. Every operation is scoped to the partnerships you can access and follows the portal’s visibility rules; there’s nothing to delete, and creating or updating anything requires a write-scoped connection (OAuth session or API key). Mechanically, the server exposes three discovery tools — list_endpoints, get_endpoint_schema, and call_endpoint — over the partner API’s operations, so your client browses and calls them in natural language rather than needing one hard-coded tool per endpoint. Use the URL for the region your company’s portal runs in: Your portal’s API & MCP page also shows your URL directly.

​
Connect with OAuth

For interactive clients (Claude, ChatGPT, Cursor, or any OAuth-capable MCP client):
  1. In your client, add a remote MCP server or custom connector using your region’s URL from the table above.
  2. The client opens your Partner Portal sign-in page. Log in as usual.
  3. Review and approve access on the consent screen. No API key is needed.
  4. You’re returned to your client, connected. Tokens refresh automatically; revoke access any time by removing the connector.

​
Connect with an API key

Headless runtimes, open-source models, and CI can’t do the browser sign-in, so they connect with a partner API key instead — the same keys the Partner API accepts. Create one on the portal’s API & MCP page, then send it as a Bearer credential:

​
Field requirements

Leads and deals can carry required or rule-controlled custom fields. The MCP server exposes the same getPartnerLeadRequirements / getPartnerDealRequirements operations as the Partner API through its normal discovery tools — no special MCP handling needed. The recommended call order for a client creating or updating a lead or deal is: call the matching requirements operation first to learn which fields are required or rule-controlled, then create/update, and if that returns a validation_error, read error.details[] (each entry has a field id and a machine-readable reason) to repair and retry.

​
Scopes and permissions

Your connection carries exactly the permissions of the OAuth session or API key you connected with — read and/or write. A read-only key or session never sees write tools.

​
Troubleshooting

No write tools show up in your client. Your key or OAuth session only has read access. Create or connect with a key/session that has write access if you need to create or update records. 403 error: “Partner API access is not enabled for this company”. The company that runs your portal hasn’t turned on the Partner API module for their account. Contact them to enable it. 403 error: “The Leads/Deals area is not available in your partner portal”. The company hasn’t exposed that area to this partnership in the partner portal. Ask the vendor to enable the relevant area; see Visibility in the Partner API guide. Deal creation can also be disabled separately; ask the vendor to enable deal creation if you receive that 403 response. The connection works, but a record you expect isn’t there. Partner API responses follow the same visibility rules as the partner portal — see Visibility in the Partner API guide.

​
Learn more

See the Partner API guide for authentication details, company and partnership scoping, and visibility rules — the MCP server follows the same rules.