Skip to content

API & developers · 4 min read

Connect an assistant with MCP

Use the read-only /mcp tools with the same API account permissions.

Use MCP for the same read-only market tools

MCP exposes a curated set of OrderMap market-data and analytics operations to compatible assistants. It uses the same developer account permissions and endpoint validation as REST, rather than granting the assistant a separate privileged account. The tools read information; they do not place orders. API Developer and API Pro are separate from terminal subscriptions, so a terminal chart being available does not prove an MCP call is authorized. Start by confirming the API account state and choosing a client that supports the documented remote transport and authentication headers.

Copy the running environment's configuration

Open Developers → MCP and inspect the displayed server configuration and tool list. Use the /mcp URL on the environment you intend to query. A local development address and a deployed production address are different service instances with potentially different data and configuration. The remote client must support the documented Streamable HTTP connection and a custom Authorization header. Copy the configuration structure, then supply the private key through the client's supported secure configuration mechanism rather than pasting it into a public prompt or shared example.

Authenticate with a developer key

Use Authorization: Bearer followed by a valid om_ developer key in the supported header. The key belongs to a project and account, and its full value is shown only when created. A browser session cookie is not a replacement for this developer authentication. If the client cannot send the required header, changing the market symbol will not solve the connection issue. Never move the secret into the URL to work around a header limitation; the API rejects query-string credentials and URLs can be logged or shared.

  1. Open Developers → MCP and copy the correct server URL and configuration shape.
  2. Configure a valid developer key through the client's supported authentication header.
  3. Connect and inspect the advertised tools before making a narrow test call.

Read the advertised tool schema

The MCP tool list is curated and need not expose every REST operation. Inspect the available tool's input schema before asking the assistant to fill its parameters. An exact option-contract query needs the correct root, expiry, strike and right, while an aggregate endpoint can use a family selection. Date, session and history rules remain those of the underlying endpoint. If a needed route is absent from the curated list, use the REST API rather than assuming the assistant can invent an undocumented tool name or bypass the catalog.

Keep tool results tied to coverage

A successful tool call can return data with the same delay, source and coverage qualifications as a REST request. Ask the assistant to retain those fields when explaining a result. A partial captured interval should not become a claimed full-session total, and missing observations should not be described as zero activity. Paginated tools require their documented continuation, including cases where a filtered scan yields an empty page with more work remaining. MCP changes how a tool is invoked, not the completeness or market meaning of the underlying response.

Budget assistant activity with your other clients

MCP shares the account's allowance of 250 requests per rolling minute and a 30-per-second burst limit, together with applicable concurrency and dataset limits. There are no usage credits. An assistant making several exploratory calls uses the same account capacity as your scripts and reference simulator. Use narrow selections and bounded follow-up queries, and honor retry instructions when returned. Rephrasing a request or creating another project does not create additional authority or a new quota. Keep the task focused enough that repeated broad scans are unnecessary.

Troubleshoot connection and tool failures separately

If the client cannot connect, check the server URL, transport support, authentication header and key first. If tools list successfully but a call fails, inspect the structured endpoint error, parameters, API plan, history and dataset state. Tool errors can contain the same underlying error body as REST, including a request identifier useful for support. Provide that identifier, tool name, safe parameters and client name when reporting a problem. Keep the full key out of tickets and public assistant configurations; a configured tool list is not proof that every live dataset has been exercised.

More in API & developers