Skip to content

MCP Server

The Cavai Documentation site exposes an MCP (Model Context Protocol) endpoint that allows AI assistants to search and retrieve documentation content. This is useful for getting grounded answers about the platform, onboarding, and building integrations.

Endpoint

Your MCP endpoint:

The endpoint accepts POST requests using the MCP Streamable HTTP transport with JSON responses.

Authentication

All requests require a Bearer token in the Authorization header. Two API key tiers are available:

KeyAccess
Guide keyUser Guide pages and the landing page only
All keyAll pages including Developer Docs

Contact the Cavai team to obtain an API key.

Tools

search_docs

Full-text search across the documentation. Returns matching page titles, paths, excerpts, and relevance scores.

ParameterTypeDescription
querystringSearch query (required)
limitnumberMax results to return, 1–50 (default 10)

get_page

Retrieve the full markdown content of a documentation page.

ParameterTypeDescription
pathstringRelative path to the page, e.g. guide/views/campaigns.md (required)

Returns an error if the page doesn't exist or is outside your access tier.

list_pages

List all available documentation pages with their titles and paths. No parameters. The result is filtered based on your access tier.

Client Configuration

Your MCP endpoint:

In the examples below, replace ENDPOINT_URL with the endpoint shown above and YOUR_API_KEY with your actual API key.

Claude Code

Run this command to add the server:

bash
claude mcp add --transport http cavai-docs ENDPOINT_URL \
  --header "Authorization: Bearer YOUR_API_KEY"

Or add to your Claude Code settings (.claude/settings.json):

json
{
  "mcpServers": {
    "cavai-docs": {
      "type": "http",
      "url": "ENDPOINT_URL",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Cursor

Add to your Cursor MCP settings (.cursor/mcp.json):

json
{
  "mcpServers": {
    "cavai-docs": {
      "type": "streamable-http",
      "url": "ENDPOINT_URL",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Claude Desktop

Claude Desktop does not support remote MCP servers directly in claude_desktop_config.json. Use the mcp-remote package as a proxy instead.

Add to your Claude Desktop config (claude_desktop_config.json):

json
{
  "mcpServers": {
    "cavai-docs": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "ENDPOINT_URL",
        "--header",
        "Authorization:${AUTH_TOKEN}"
      ],
      "env": {
        "AUTH_TOKEN": "Bearer YOUR_API_KEY"
      }
    }
  }
}

TIP

The auth token is passed via an environment variable to avoid a known issue with spaces in arguments on Windows and macOS.

MCP Inspector

For testing, use the MCP Inspector:

bash
npx @modelcontextprotocol/inspector

Set the transport to Streamable HTTP, enter the endpoint URL, and add the Authorization header.