Skip to content

Docs MCP Server ​

Cavai has two MCP servers: this one for documentation (read-only search and retrieval) and the API MCP Server for platform operations (create, update, and manage campaigns, creatives, and more). They work well together — see Using Both Servers Together.

The Docs MCP server 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 ​

https://docs.cavai.com/api/mcp

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

Authentication ​

All requests require an API key. You can provide it in two ways:

  • Authorization header — Authorization: Bearer YOUR_API_KEY
  • Query parameter — append ?token=YOUR_API_KEY to the endpoint URL

The query parameter option is useful for clients like Claude Desktop that don't support custom headers in their GUI.

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 ​

In the examples below, replace 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 https://docs.cavai.com/api/mcp \
  --header "Authorization: Bearer YOUR_API_KEY"

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

json
{
  "mcpServers": {
    "cavai-docs": {
      "type": "http",
      "url": "https://docs.cavai.com/api/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Cursor ​

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

json
{
  "mcpServers": {
    "cavai-docs": {
      "type": "streamable-http",
      "url": "https://docs.cavai.com/api/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Claude Desktop ​

Go to Settings → Connectors → Add MCP Server and enter the endpoint URL with your API key as a query parameter:

https://docs.cavai.com/api/mcp?token=YOUR_API_KEY

No additional configuration is needed.

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.