How do I install Octri API Docs?

Install via Claude Code (local): 1. Install Claude Code CLI 2. Copy the command below, replace with real env values, then run in terminal 3. See Environment variables below if listed Example: claude mcp add mcp --env OCTRI_PROJECT_ID= -- npx -y @octri/mcp

What is Octri API Docs good for?

Octri API Docs can be used in AI agent workflows that need this MCP Server. Review the docs and install commands on this page.

Octri API Docs MCP Setup & Guide

MCP ServerMCP RegistryOfficial

dev.octri/mcp · v1.1.1

Search an Octri project's API docs and call its endpoints as tools, shaped by its SDK Studio config.

View on MCP Registry ↗Repository ↗

Copy the install config on this page first, then verify docs and permissions upstream.

Overview

Search an Octri project's API docs and call its endpoints as tools, shaped by its SDK Studio config. Octri API Docs is a MCP Server listed from MCP Registry. Transports: stdio. This page includes an overview, setup tutorial, install commands, and use cases for Trae, Tongyi Lingma, Cursor, Claude Code, and VS Code.

AgentHub Verified AvailabilityTested & Ready

Automated pipeline validated install commands, protocol & client compatibility

Verified At2026-10-04

Install Snippets TestedCLI & JSON config syntax verified

Protocol Handshake ReadyComplies with JSON-RPC 2.0 specifications

Origin Registry ActiveSourced from official-mcp-registry

Verified ClientsClaude Code、Claude Desktop、Cursor 等

Security Tier: A+ 级 · 官方认证推荐 (A+)·Maintained by official/verified teams, audited for standard MCP protocol compliance.

Score 90/100

Copy by platform

Choose your platform

Open or create .cursor/mcp.json in your project root
Click Copy config and paste; merge only this mcpServers entry if others exist
Replace <placeholders> in env with real secrets (see Environment variables below)
Save, then Cmd+Shift+P → Reload Window

Pre-fill Environment Variables (Optional)

OCTRI_PROJECT_ID

Required

OCTRI_API_BASE_URL

OCTRI_API_TOKEN

secret

OCTRI_API_KEY

secret

OCTRI_API_KEY_HEADER

OCTRI_API_USERNAME

OCTRI_API_PASSWORD

secret

Privacy Guarantee: Keys are replaced 100% locally in your browser memory and are NEVER uploaded or stored on any server.

Click to copy snippet

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

Setup tutorial

Open the Octri API Docs page and confirm this MCP Server (source: MCP Registry).
Copy the Cursor, Claude Code, or VS Code snippet.
Merge it into mcpServers and replace env placeholders with real secrets.
Reload the window, then call the MCP tools from your agent chat.

Install commands

Install commands and setup steps are in the HTML so search engines and no-JS browsers can read them without running client JavaScript.

Claude Code (local)

Install Claude Code CLI
Copy the command below, replace <placeholders> with real env values, then run in terminal
See Environment variables below if listed

claude mcp add mcp --env OCTRI_PROJECT_ID=<OCTRI_PROJECT_ID> -- npx -y @octri/mcp

Cursor — .cursor/mcp.json (local)

Open or create .cursor/mcp.json in your project root
Click Copy config and paste; merge only this mcpServers entry if others exist
Replace <placeholders> in env with real secrets (see Environment variables below)
Save, then Cmd+Shift+P → Reload Window

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

VS Code — .vscode/mcp.json (local)

Install GitHub Copilot in VS Code with MCP support
Open or create .vscode/mcp.json in your project root
Click Copy config and paste; merge only this mcpServers entry if others exist
Replace <placeholders> in env with real secrets
Save and Developer: Reload Window

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

Claude Desktop — claude_desktop_config.json (local)

Open Claude Desktop claude_desktop_config.json (see remote guide for paths)
Click Copy config and merge under mcpServers
Replace <placeholders> in env with real secrets
Fully quit and restart Claude Desktop

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

Trae — .trae/mcp.json (local)

Trae → Settings → MCP, or edit .trae/mcp.json / global mcp.json
Click Copy config and merge mcpServers
Replace <placeholders> in env with real secrets
Save and reload Trae

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

Cherry Studio — MCP settings (local)

Cherry Studio → Settings → MCP Servers → Add (STDIO)
Or import JSON: click Copy config and merge mcpServers
Replace <placeholders> in env; ensure Node.js / uv (npx, uvx) are installed
Enable the server and check tools load

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

Tongyi Lingma — MCP config (local)

Lingma Settings → MCP → + → STDIO or config file
Click Copy config and merge mcpServers
Replace <placeholders> in env; need Node.js 18+ (npx) or uv (uvx)
Confirm connected before using tools in agent chat

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

Windsurf — mcp_config.json (local)

Edit ~/.codeium/windsurf/mcp_config.json
Click Copy config and merge mcpServers (stdio same as Cursor)
Replace <placeholders> in env, save, refresh Cascade

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

Cline — MCP Servers (local)

Cline panel → Settings → MCP Servers
Click Copy config and merge
Replace <placeholders> in env, then save

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

WorkBuddy — .workbuddy/mcp.json (local)

Edit ~/.workbuddy/mcp.json (user) or project .workbuddy/mcp.json
Or Plugins → MCP Servers → Configure MCP and paste the JSON below
Replace <placeholders> in env; on Windows prefer absolute paths for command/scripts
Save, restart WorkBuddy, confirm connector status is green

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octri/mcp"
      ],
      "env": {
        "OCTRI_PROJECT_ID": "<OCTRI_PROJECT_ID>"
      }
    }
  }
}

Troubleshooting & Common ErrorsFAQ

Common connection errors and verified fixes for Octri API Docs

Getting 'connection closed' or exit code 1 in Cursor / Claude Code for Octri API Docs?

Usually caused by missing runtime paths or IDE environment inheritance. Fix steps: 1. Verify Node.js 18+ (npx) or Python 3.10+ (uvx) is installed; 2. Run 'which npx' or 'which uvx' in terminal, and replace 'command' with absolute path; 3. Reload or restart the client window after modifying config.

Fix Snippet

# Check binary path in terminal:
which npx
node -v

Getting 'spawn npx ENOENT' or 'command not found'?

The editor background process does not inherit your full terminal PATH. Solution: Globally install the package, or set the absolute binary path (e.g. C:\Program Files\nodejs\npx.cmd on Windows, or /usr/local/bin/npx on macOS).

Missing required environment variable or authentication failure?

Octri API Docs requires environment variables (OCTRI_PROJECT_ID). Ensure you have added valid keys under the 'env' object in your config file without trailing whitespace.

Fix Snippet

// .cursor/mcp.json 或 claude_desktop_config.json
{
  "env": {
    "OCTRI_PROJECT_ID": "your_actual_key_here"
  }
}

Still not connecting? Read the MCP troubleshooting guide →

Tool Mock Playground

Sandbox

Octri API Docs Tool Interface Simulation · Preview tool schema & outputs without local runtime

Sandbox Ready

fn: mcpExecute the core tool interface of Octri API Docs

Request ArgumentsJSON Schema

{
  "target": "Octri API Docs",
  "action": "execute",
  "options": {
    "mode": "standard",
    "timeoutMs": 5000
  }
}

💡Parameters generated dynamically by Agent runtime

Agent Tool Output

Click 'Run Mock' above

to preview the raw response returned to the LLM

Env: AgentHub Virtual SandboxJSON-RPC 2.0

Decision Guide: Why & When to Use

Assess suitability before installing to save trial-and-error time

Best Suited For

When your AI Agent needs tool calling capabilities in this domain
Automating repetitive workflows in your IDE or terminal
Pairing with modern clients supporting MCP/Skill standards

When NOT to Use

When missing required API secrets or local runtime prerequisites
Pure conversational requests that don't need external system access

Recommended Workflow Pairing:

Most people compare similar tools or check scenario guides before installing—start here.

Browse more like this Search similar Pick by scenario Prompt playbooks MCP hands-on Reviews & comparisons

Listing badge: put AgentHub on your site

Copy either snippet into your project homepage, docs, or GitHub README. The badge is a hotlinked SVG — nothing to host — and it links back to this page so visitors can find the install steps.

Preview

HTML

<a href="https://myagenthub.cn/p/dev.octri/mcp" title="Listed on AgentHub: Octri API Docs" target="_blank" rel="noopener">
  <img src="https://myagenthub.cn/badge/dev.octri/mcp?lang=en" alt="Listed on AgentHub: Octri API Docs" height="20" style="border:0"/>
</a>

Markdown (GitHub README)

[![Listed on AgentHub: Octri API Docs](https://myagenthub.cn/badge/dev.octri/mcp?lang=en)](https://myagenthub.cn/p/dev.octri/mcp)

Badges are generated on the fly from /badge/<package-id>, so name and listing changes propagate automatically. Keep the link target unchanged — it is what counts as the referral.

Unified Manifest

{
  "id": "dev.octri/mcp",
  "type": "mcp-server",
  "version": "1.1.1",
  "displayName": "Octri API Docs",
  "description": "Search an Octri project's API docs and call its endpoints as tools, shaped by its SDK Studio config.",
  "repository": {
    "url": "https://github.com/octridev/octri-mcp",
    "source": "github"
  },
  "homepage": "https://octri.dev",
  "distribution": {
    "packages": [
      {
        "registryType": "npm",
        "identifier": "@octri/mcp",
        "version": "1.1.1",
        "runtimeHint": "npx",
        "transport": "stdio",
        "environmentVariables": [
          {
            "name": "OCTRI_PROJECT_ID",
            "description": "The Octri project whose docs and endpoints this server exposes.",
            "isRequired": true
          },
          {
            "name": "OCTRI_API_BASE_URL",
            "description": "Base URL for endpoint calls. Defaults to the Base URL set in the project's SDK Studio."
          },
          {
            "name": "OCTRI_API_TOKEN",
            "description": "Bearer or OAuth2 token for the documented API, not for Octri.",
            "isSecret": true
          },
          {
            "name": "OCTRI_API_KEY",
            "description": "API key for the documented API, not for Octri. Sent in the OCTRI_API_KEY_HEADER header.",
            "isSecret": true
          },
          {
            "name": "OCTRI_API_KEY_HEADER",
            "description": "Header that carries OCTRI_API_KEY."
          },
          {
            "name": "OCTRI_API_USERNAME",
            "description": "Basic-auth username for the documented API."
          },
          {
            "name": "OCTRI_API_PASSWORD",
            "description": "Basic-auth password for the documented API.",
            "isSecret": true
          }
        ]
      }
    ],
    "remotes": []
  },
  "dependencies": [],
  "installTargets": [
    "claude-code",
    "claude-desktop",
    "cursor",
    "vscode",
    "trae",
    "cherry-studio",
    "lingma",
    "windsurf",
    "cline",
    "workbuddy"
  ],
  "keywords": [],
  "provenance": {
    "origin": "official-mcp-registry",
    "originalId": "dev.octri/mcp",
    "originalUrl": "https://registry.modelcontextprotocol.io/v0.1/servers/dev.octri%2Fmcp/versions/latest",
    "isOfficial": true,
    "status": "active"
  }
}