New:Microsoft Teams Notifications Are Now Available in Socket.Learn more →
Get Started

@octri/mcp

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@octri/mcp

MCP server for Octri API documentation — use your API docs as context in Claude, Cursor, and more

Source
npmnpm
Version
1.0.0
Version published
Weekly downloads
202
12.85%
Maintainers
1
Weekly downloads
 
Created
Source

@octri/mcp

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 octri.dev/mcp.

Node 20 or newer. Runs over stdio for a local client, or SSE when you host it.

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.

Tools

ToolDescription
search_docsSearch the API documentation for an endpoint or concept
get_endpointGet full documentation for a specific API endpoint
list_endpointsList all available API endpoints, optionally filtered by section
get_changelogGet recent API changes and breaking changes
list_sdksList the available SDK client libraries (languages, versions, download links)
get_guideGet the full content of a written guide by its slug
get_sdk_methodsGet 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):

{
  "mcpServers": {
    "my-api-docs": {
      "command": "npx",
      "args": ["@octri/mcp", "--project-id", "YOUR_PROJECT_ID"]
    }
  }
}

Cursor

Add to .cursor/mcp.json in your project root (or ~/.cursor/mcp.json globally):

{
  "mcpServers": {
    "my-api-docs": {
      "command": "npx",
      "args": ["@octri/mcp"],
      "env": {
        "OCTRI_PROJECT_ID": "YOUR_PROJECT_ID"
      }
    }
  }
}

VS Code (Copilot / MCP extension)

Add to .vscode/mcp.json:

{
  "servers": {
    "my-api-docs": {
      "type": "stdio",
      "command": "npx",
      "args": ["@octri/mcp", "--project-id", "YOUR_PROJECT_ID"]
    }
  }
}

Environment variables

VariableRequiredDefaultDescription
OCTRI_PROJECT_IDYes*—The project to connect to. Can also be set via --project-id CLI flag.
OCTRI_API_URLNohttps://api.octri.dev/api/v1Override the API base URL (useful for self-hosted deployments).
MCP_TRANSPORTNostdioSet to sse for remote/Docker hosting.
PORTNo3000HTTP port when using SSE transport.

* Required unless every tool call passes projectId explicitly.

Remote hosting (Docker / SSE transport)

The server supports SSE (Server-Sent Events) transport for remote deployment:

docker build -t octri-mcp .

docker run -p 3000:3000 \
  -e OCTRI_PROJECT_ID=YOUR_PROJECT_ID \
  octri-mcp

The container exposes two endpoints:

  • GET /sse — opens an SSE connection (configure this URL in your MCP client)
  • POST /messages?sessionId=<id> — relay endpoint for client-to-server messages

Configure a remote MCP client to connect to http://your-host:3000/sse.

Local development

# Build
pnpm build

# Run in stdio mode
OCTRI_PROJECT_ID=my-project node dist/index.js

# Run in SSE mode
MCP_TRANSPORT=sse OCTRI_PROJECT_ID=my-project node dist/index.js

Publishing

pnpm build
npm publish --access public

Requires an npm account with access to the @octri scope.

The rest of Octri

ProductWhat it does
API StudioYour OpenAPI spec becomes a hosted documentation site with a live request playground, editable page by page.
SDK StudioThe same spec becomes client libraries for ten languages, versioned and released together.
MCPYour endpoints and docs become tools an AI assistant can call, generated from the same spec.
MonitoringErrors, traces, uptime and releases for the API, joined to the SDK calls that reached it.

Monitoring runtimes

Node · Python · Go · Ruby · Rust · PHP · Java · Kotlin · Swift · Dart

Documentation · Pricing · Changelog

MIT licensed.

Keywords

mcp

FAQs

Package last updated on 10 Sep 2026

Related posts