Connecting from
What each agent platform needs from Cypress, Claude, ChatGPT, Cursor, Copilot Studio, Agentforce, Palantir or your own, and which door to use.
TL;DRAI summary
This chapter explains how to connect your platform to Cypress. You need a specific address and a credential, like an API key or Connect Cypress (OAuth), to access Cypress features such as vehicle data or operational tools.
Every platform needs the same two things from Cypress: an address and a credential. What differs is the door it uses: an MCP server for an agent that calls tools, the REST API and webhooks for a platform that keeps its own copy of your records, or an OpenAPI document for one that turns operations into actions. This page says which, platform by platform. Your platform's own documentation has its screens and steps.
What Cypress gives every platform
| You need | Where |
|---|---|
| Cypress Operate, the MCP server that works in your organization | https://app.getcypress.ai/api/mcp/operate: the core tools by default, ?toolsets=all for every operation as a tool |
| Cypress Intelligence, the read-only MCP server of what Cypress knows | https://app.getcypress.ai/api/mcp/intelligence |
| The Cypress Manual, these docs over MCP, no credential | https://app.getcypress.ai/api/mcp/manual |
| The REST API | https://app.getcypress.ai/api/v1 |
| Every operation, as OpenAPI 3.1 | https://app.getcypress.ai/api/public/openapi.json |
| The core operations, as OpenAPI 3.1, and as 3.0 for importers that read no later version | https://app.getcypress.ai/api/public/openapi-core.json, https://app.getcypress.ai/api/public/openapi-core-3.0.json |
| Changes as they happen | Webhooks, or the event log, GET /api/v1/events |
Choosing the credential
- An API key (
cyp_live_, orcyp_test_in a sandbox) acts as your organization. Send it asAuthorization: Bearer cyp_…, or asx-api-key: cyp_…where a platform lets you name the header but not the word before the key. This is the credential for a platform that calls Cypress server to server. - Connect Cypress (OAuth 2.1 with PKCE) acts for the person who approved it, or for an agent the app added. The MCP servers name it when a client calls them without a credential, so a client that signs in by itself finds it. A client may name itself by the https address of its client ID metadata document, with no registration, or register itself (RFC 7591); an app many organizations use can be registered with Cypress.
Who each credential acts as, and what it may do, is in Keys and tokens.
Platform by platform
| Platform | Door | Credential |
|---|---|---|
| Claude Code, Claude Desktop, Cursor | The MCP servers. The MCP quickstart has each client's setup | An API key in the Authorization header |
| Claude and ChatGPT, as a connector | The MCP servers, added as a remote MCP server (a custom connector) by its address. ChatGPT reaches them in its developer mode | Connect Cypress, as above: the connector signs in with OAuth |
| Microsoft Copilot Studio | The MCP servers, added as a Model Context Protocol tool by its address (Streamable HTTP) | OAuth with dynamic discovery: Copilot Studio registers itself and an admin approves it; or an API key in the x-api-key header |
| Salesforce Agentforce | Its actions from the core operations: import openapi-core-3.0.json with External Services (it reads OpenAPI 2.0 and 3.0, not 3.1). Or the MCP servers, where your org adds external MCP servers | An API key in a named credential's header |
| Palantir Foundry and AIP | The REST API as a REST API source, the lists with updatedAfter and the event log to keep the ontology in step, and webhooks to a Foundry listener; actions through the same REST source | An API key in the source's header |
| Your own agent or platform | The MCP servers for tools; the REST API and webhooks for data | An API key, or Connect Cypress for an app many organizations use |
A platform that keeps its own model of your records maps it from Domain model and keeps it in step as Events and sync says.
Whatever the platform
- Start in a sandbox. A test key acts in a sandbox only, and nothing there reaches a real dealer, buyer or contact.
- Show the agent less. By default it sees the 13 core tools, not about
400; an area on the address, such as
?toolsets=core,closings, adds that area's own. A gateway with its own tool search asks forall. - Hand over what is a person's. A decision Cypress keeps for a person
answers
NEEDS_PERSONwith a link, on every platform. A platform that asks a person before a tool runs can ask by the tool's annotations: a read-only tool, one that changes something, one that takes something away (destructiveHint), one that reaches people outside Cypress (openWorldHint).
Events and sync
Keep a copy of your Cypress records in step, in a platform's model or your own warehouse. Backfill with the lists, follow every change by webhook or from the event log, reconcile, and mirror what waits for a person.
Evaluations
A set of tasks to measure an agent working in Cypress, each with what a good run does, what it must never do, and the read that proves it. Run them in a sandbox.