English
MCP server
Routes are relative to <PUBLIC_BASE_URL>; request and response bodies are JSON unless stated otherwise. Authentication, scopes, pagination and the error format are described in the REST API guides.
POST /api/v1/mcp
MCP server (Streamable HTTP)
The Model Context Protocol endpoint of the instance, Streamable HTTP transport, stateless. Authenticate with an API key: each tool requires the scope of its domain, write tools the write verb. JSON-RPC bodies as per the MCP specification.
Access — Member session or API key; scopes are checked per tool.
Request body (application/json)
Type : object
json
{
"type": "object",
"propertyNames": { "type": "string" },
"additionalProperties": {}
}Responses
200 — A JSON-RPC response (or an SSE stream).
Type : object
json
{
"type": "object",
"propertyNames": { "type": "string" },
"additionalProperties": {}
}400 — The request does not match its schema.
401 — No valid session or API key (auth.unauthenticated).
403 — Refused: insufficient role (auth.forbidden), missing scope (api_key.scope_missing, details.required names it) or a route closed to API keys (api_key.session_required).
429 — The API key exceeded its rate limit (api_key.rate_limited); Retry-After says when to retry.