An MCP server that turns your API documentation into tools an AI assistant can
call. Claude, Cursor, VS Code Copilot, and any other MCP client can search your
endpoints, open a guide, pull a ready-to-use SDK snippet in any supported
language, and check the changelog for breaking changes, all from the same
OpenAPI spec your docs are built from.
Octri turns an OpenAPI spec into a documentation site, client SDKs for ten
languages, an MCP server your AI assistant can call, and monitoring for the
API behind them. This package is the MCP server. See
.
Search an Octri project's API docs and call its endpoints as tools, shaped by its SDK Studio config.
Node 20 or newer. Runs over stdio for a local client, or Streamable HTTP when
you host it.
Operation bodies use documented media type. For multipart or binary values,
pass files only as bounded inline descriptor:
{ "filename": "report.csv", "content": "base64...", "contentType": "text/csv" }.
Paths and URLs are intentionally unsupported.
Explicit URL-encoded deepObject fields with explode: true use bracketed
wire keys, including nested objects and arrays. This covers APIs such as Stripe
that mark fields like invoice_settings and tax_id_data as deepObject.
Install
npx -y @octri/mcp
Most clients are configured with that command, so a global install is optional.
The Installation section below has the exact config block for each one.
Or install it in one click. VS Code asks for your project ID; Cursor writes
YOUR_PROJECT_ID into its mcp.json for you to replace.
Listed in the official MCP Registry as dev.octri/mcp.
Tools
Tool
Description
search_docs
Search the API documentation for an endpoint or concept
get_endpoint
Get full documentation for a specific API endpoint
list_endpoints
List all available API endpoints, optionally filtered by section
get_changelog
Get recent API changes and breaking changes
list_sdks
List the available SDK client libraries (languages, versions, download links)
get_guide
Get the full content of a written guide by its slug
get_sdk_methods
Get ready-to-use SDK code snippets for each endpoint in every supported language
Installation
Claude Desktop
Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
The project to connect to. Can also be set via --project-id CLI flag.
OCTRI_API_URL
No
https://api.octri.dev/api/v1
Override the API base URL for local development or an authorized private test endpoint. Hosted Octri self-hosting is not available.
MCP_TRANSPORT
No
stdio
http for remote hosting (Streamable HTTP), or sse for the legacy transport.
PORT
No
3000
HTTP port for the http and sse transports.
MCP_HOST
No
127.0.0.1
Interface to bind. Widening it requires MCP_AUTH_TOKEN.
MCP_ALLOWED_ORIGINS
No
None
Comma-separated browser origins allowed to reach an HTTP transport.
MCP_AUTH_TOKEN
When MCP_HOST is not loopback
None
Bearer token every HTTP request must send as Authorization: Bearer <token>.
* Required unless every tool call passes projectId explicitly.
Credentials for the API being called
Operation tools call your real API, and these supply its credentials:
Variable
Description
OCTRI_API_BASE_URL
Target API base for operation calls (falls back to the studio's Base URL).
OCTRI_API_TOKEN
Bearer / OAuth2 token.
OCTRI_API_KEY (+ OCTRI_API_KEY_HEADER)
API-key value, and the header it goes in (default X-API-Key).
OCTRI_API_USERNAME / OCTRI_API_PASSWORD
Basic-auth credentials.
All of these are sent as HTTP headers. An API that takes its credentials in
the request body instead (Plaid's client_id and secret, for example) is
not served by them: those are ordinary body fields, so they appear as tool
arguments and the agent passes them like any other field. Setting
OCTRI_API_KEY for such an API adds a header it ignores.
Permissions
The project owner sets every operation tool to run on its own, ask first, or
off, and publishes that from the MCP page. Reads run on their own by default and
everything else asks first. An "ask first" call is shown to the user through MCP
elicitation (Claude Code 2.1.76+, VS Code) with its method, URL and body, and is
sent only on approval. A client that cannot ask is refused the call instead.
These narrow what the owner allowed. Only ALLOW widens anything, and nothing
brings back a tool the owner turned off:
Variable
Flag
Effect
OCTRI_READ_ONLY=1
--read-only
List and run only tools that read.
OCTRI_DENY_TOOLS=a,b
--deny-tools a,b
Never list or run these tools.
OCTRI_ALLOW_TOOLS=a,b
--allow-tools a,b
Run these "ask first" tools without asking (* for all).
OCTRI_ALLOW_WRITES=1
--allow-writes
Same as OCTRI_ALLOW_TOOLS=*.
OCTRI_DRY_RUN=1
--dry-run
Build each call and return it to the agent unsent.
Usage reporting
Each tool call reports its tool name, outcome, duration and the client's name to
Octri, so the project owner can see which tools agents use. Arguments and
responses are never sent. Set OCTRI_TELEMETRY=0 or pass --no-telemetry to
turn it off.
Remote hosting
Use Streamable HTTP (MCP_TRANSPORT=http), the transport the MCP spec has
defined for remote servers since revision 2025-03-26 and the one a current
client tries first:
It serves a single endpoint, /mcp. A client's first request opens a session
and gets its id back in the mcp-session-id header; every later request
carries it and reaches the same server. That is what lets a tool that asks
first work: the approval prompt goes out in the middle of a call and the
answer comes back on another request. Sessions idle for 30 minutes are closed.
Behind more than one replica, route by mcp-session-id (sticky sessions).
Point a remote MCP client at http://your-host:3000/mcp.
Legacy HTTP+SSE transport
MCP_TRANSPORT=sse serves the older 2024-11-05 design, kept so existing
deployments keep working. It exposes GET /sse to open a connection and
POST /messages?sessionId=<id> to relay client messages. Prefer http for
anything new.
Binding and origins
Both HTTP transports bind 127.0.0.1 by default and refuse any request whose
Origin is not listed in MCP_ALLOWED_ORIGINS, or whose Host is not
loopback. This server holds your API credentials, and any page the browser
visits can reach a loopback port.
Widening MCP_HOST puts those credentials on the network, so the server then
refuses to start without MCP_AUTH_TOKEN, and every request must send
Authorization: Bearer <token>. Configure the same header in your MCP client,
and list browser origins explicitly.
Check your setup
npx -y @octri/mcp doctor --project-id YOUR_PROJECT_ID
Confirms the project and its tools load, the base URL and credentials are set,
and makes one real read call, then says what to fix if anything fails.
--no-call skips the call. Exits non-zero on a failure.
Local development
# Build
pnpm build
# Run in stdio mode
OCTRI_PROJECT_ID=my-project node dist/index.js
# Run in Streamable HTTP mode (POST /mcp)
MCP_TRANSPORT=http OCTRI_PROJECT_ID=my-project node dist/index.js
# Run in the legacy SSE mode
MCP_TRANSPORT=sse OCTRI_PROJECT_ID=my-project node dist/index.js
As a library
The octri-mcp command is one host for the server core. createServer takes
the tool source and everything else a host decides:
Ainda não há lista de ferramentas. Servidores remotos recebem uma após a primeira verificação de saúde.
Perguntas frequentes
Perguntas
Como instalo Octri API Docs?
Copie nesta página a configuração stdio para Cursor, Claude Desktop, Claude Code ou VS Code. Ela usa a instalação do publicador, não um proxy do PlugMCP.
Octri API Docs precisa de uma chave de API?
O publicador lista estas variáveis de ambiente: OCTRI_PROJECT_ID, OCTRI_API_BASE_URL, OCTRI_API_TOKEN, OCTRI_API_KEY, OCTRI_API_KEY_HEADER, OCTRI_API_USERNAME, OCTRI_API_PASSWORD.
Qual transporte Octri API Docs usa?
Octri API Docs roda localmente via stdio.
Quando Octri API Docs foi verificado pela última vez?
Última verificação: 2026-11-11. Search an Octri project's API docs and call its endpoints as tools, shaped by its SDK Studio config.
