Skip to main content

MCP API

MCP endpoints exposed by the Devotel CPaaS API Base path: /api/v1/public/mcp/.well-known/mcp.json Endpoint count: 1

title: “MCP discovery manifest — worked sample” description: “The full .well-known server.json manifest an MCP client reads before it connects, field by field.”

Hosted MCP server discovery manifest (public)

Orbit runs a hosted remote MCP server at POST /api/v1/mcp (Streamable-HTTP JSON-RPC) that lets an MCP-aware agent host or aggregator drive Orbit’s CPaaS capabilities — messaging, voice, contacts, campaigns, analytics — without running a local process. But callers need to know the server exists before they hold an Orbit API key. This public, unauthenticated endpoint fills that gap: it returns a standard MCP Registry server.json-shaped manifest that aggregators, crawlers, and MCP clients can read to auto-discover and auto-configure the server. The same manifest is also served from two self-serve copies — https://orbit.devotel.io/.well-known/mcp.json for self-hosted discovery and apps/mcp-server/server.json in the repo — kept in lockstep so every discovery path sees the same payload.

Response example

200

Caching

The response carries a Cache-Control: public, max-age=300, s-maxage=300, stale-while-revalidate=600 header. Manifest contents change rarely (only when the hosted server version is bumped), so aggregators can cache the response for up to five minutes and serve stale content for ten minutes while revalidating in the background. Treat the version field as eventually consistent — a newly deployed tool catalog may take up to the cache window to surface.

No authentication required

This endpoint is registered before API-key authentication in the app’s middleware chain — it is genuinely unauthenticated by design, not just documented that way. Aggregators, registry crawlers, and MCP client transports should call it without an API key. The auto-generated request samples below show an X-API-Key header for consistency with the rest of the API reference, but the route ignores it — the key is only needed at the actual JSON-RPC endpoint (POST /api/v1/mcp), never at the discovery manifest.

Next steps

  • Make a tool call: POST /api/v1/mcp — the Streamable-HTTP JSON-RPC endpoint (see the MCP server guide for a full walkthrough).
  • Self-hosted twin files: https://orbit.devotel.io/.well-known/mcp.json and the repo file apps/mcp-server/server.json carry the same manifest for local-process and self-hosted discovery paths.

Hosted MCP server discovery manifest (public)

GET /api/v1/public/mcp/.well-known/mcp.json
Unauthenticated, server.json-shaped manifest describing Orbit’s hosted remote MCP server (POST /api/v1/mcp, Streamable-HTTP). Lets aggregators and MCP-aware agent hosts discover and auto-configure the server without a human handing out the URL.