Documentation MCP

Ramon provides a read-only local MCP server for agents that need to discover the documentation and inspect the canonical OpenAPI contract. It does not provision surveys, start scoring, retrieve participant results, or request deletion. Use the server-side Integration API for those operations.

Run the server

After the package has been published, run it with Node.js 20 or newer:

npx -y @modeleven/ramon-docs-mcp

Configure that command as a local stdio MCP server in your agent host. The server does not accept an integration key and does not need access to participant data. For clients that use an mcpServers configuration object:

{
  "mcpServers": {
    "ramon-docs": {
      "command": "npx",
      "args": ["-y", "@modeleven/ramon-docs-mcp"]
    }
  }
}

To run the server from a source checkout before the first package release:

cd ramon-docs/mcp
bun install
bun run build
node dist/cli.js

Set RAMON_OPENAPI_URL only when you need to inspect a non-production Ramon API:

RAMON_OPENAPI_URL=http://127.0.0.1:3000/openapi/doc \
  npx -y @modeleven/ramon-docs-mcp

The override must use HTTPS, except for localhost, 127.0.0.1, or host.docker.internal development URLs.

Available tools

Tool	Purpose
search_ramon_docs	Search the bundled Ramon Markdown documentation.
read_ramon_doc	Read one allow-listed document by its catalog ID.
read_ramon_api_operation	Read one operation from the live canonical OpenAPI document by operationId.

The server also publishes resources for the agent guide, document catalog, individual documentation pages, and the full OpenAPI document.

Operational integration

Read SKILLS.md for the recommended integration workflow and safety boundaries. The MCP intentionally cannot execute that workflow. Keep the private rmn_int_… key in your server-side Integration API client.