Skip to content
Last updated

Model Context Protocol server

Model Context Protocol (MCP) is a standard that enables applications to provide context to large language models (LLMs). With MCP servers, AI assistants can retrieve additional information relevant to a user's query.

Realm provides built-in MCP server capabilities that expose your API Docs to AI assistants.

Benefits

  • Real-time API guidance — users receive accurate, contextual help about API endpoints and operations.
  • Secure API access — AI assistants can make authenticated requests to act on behalf of a user.
  • Dynamic documentation — AI assistants can extract and explain API reference content based on user needs.

Docs MCP server

Use the Docs MCP server to explore and discover APIs in your project. For the current MCP endpoint details, authentication semantics, server metadata, and tool schemas, see the Docs MCP reference.

Connect an AI agent to the MCP server

After you enable the Docs MCP server in configuration, it is available at /mcp on your project root URL. For example: https://example.com/mcp.

Use the MCP server

Users can connect their preferred AI tools that support MCP (for example, Cursor, Claude Code and VS Code) to your MCP server.

  1. Enable the MCP server in your configuration.
  2. Copy your MCP server URL and add it to your tool.

After connecting, the tool can access your OpenAPI documentation.

Connect Cursor to the MCP server

  1. In Cursor, open the command palette.
    • macOS: Command + Shift + P
    • Windows/Linux: Ctrl + Shift + P
  2. Type "Open MCP settings" in the command palette.
  3. Select "Add custom MCP".

Cursor opens the mcp.json file.

Configure the MCP server

  1. In mcp.json, add your server configuration:
{
  "mcpServers": {
    "example-mcp": {
      "url": "https://example.com/mcp"
    }
  }
}

Optionally, you can also pass additional headers that will be sent with each request:

{
  "mcpServers": {
    "example-mcp": {
      "url": "https://example.com/mcp",
      "headers": {
        "Authorization": "Basic MTIzOjEyMw=="
      }
    }
  }
}
  1. Save the mcp.json file.

  2. Return to MCP settings and confirm the connection. If authentication is required, select Needs login and complete the sign‑in flow. After connecting, Cursor displays the list of available tools.

Test the Cursor connection

In Cursor chat (Agent mode), ask a question that triggers an MCP tool.

Resources