> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cockroachlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CockroachDB Docs MCP Server

export const InternalLink = ({version, path = "", children, ...props}) => {
  let detectedVersion = version || "stable";
  if (typeof window !== 'undefined' && !version) {
    const match = window.location.pathname.match(/\/docs\/([^/]+)/);
    if (match) {
      detectedVersion = match[1];
    }
  }
  const normalizedPath = path.startsWith("/") ? path.slice(1) : path;
  return <a href={`/docs/${detectedVersion}/${normalizedPath}`} {...props}>
      {children}
    </a>;
};

The CockroachDB Docs MCP Server ([Model Context Protocol](https://modelcontextprotocol.io/introduction)) enables AI assistants like Claude Desktop, Cursor, and VS Code to access CockroachDB documentation directly. Self-hosted customers can also integrate the server into custom agents and automation workflows using an [authenticated endpoint](#authenticated-endpoint-for-automation).

## Setup

Connect your AI assistant to CockroachDB documentation by configuring the MCP server. The following sections describe platform-specific instructions.

### Cursor

1. Create or open the file `.cursor/mcp.json` in your project directory.
2. Add the following configuration:

   ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
   {
     "mcpServers": {
       "cockroachdb-docs": {
         "type": "http",
         "url": "https://cockroachdb.mcp.kapa.ai"
       }
     }
   }
   ```
3. Restart Cursor to apply the configuration.
4. You can now ask questions about CockroachDB documentation directly in Cursor.

### VS Code

<Note>
  Requires VS Code 1.102 or later with GitHub Copilot.
</Note>

1. Create or open the file `.vscode/mcp.json` in your project directory.
2. Add the following configuration:

   ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
   {
     "servers": {
       "cockroachdb-docs": {
         "type": "http",
         "url": "https://cockroachdb.mcp.kapa.ai"
       }
     }
   }
   ```
3. Reload VS Code window (⌘+R).
4. The CockroachDB documentation is now available through GitHub Copilot in VS Code.

### Claude Code

1. Run the following command in your terminal:

   ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
   claude mcp add --transport http cockroachdb-docs https://cockroachdb.mcp.kapa.ai
   ```
2. Execute `/mcp` in Claude Code and authenticate via browser when prompted.

CockroachDB documentation is now accessible in your Claude Code environment.

### ChatGPT Desktop

1. Open ChatGPT Desktop.
2. Go to **Settings** → **Features** and enable **Developer mode**.
3. Navigate to **Settings** → **MCP Servers**.
4. Click **Add Server** and enter:
   * **Name**: `cockroachdb-docs`
   * **URL**: `https://cockroachdb.mcp.kapa.ai`
5. CockroachDB documentation is now accessible in ChatGPT Desktop.

### Claude Desktop

1. Open Claude Desktop configuration file:
   * **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
   * **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
   * **Linux**: `~/.config/Claude/claude_desktop_config.json`
2. Add the CockroachDB Docs MCP server to your configuration:

   ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
   {
     "mcpServers": {
       "cockroachdb-docs": {
         "type": "npx",
         "args": ["mcp-remote", "https://cockroachdb.mcp.kapa.ai"]
       }
     }
   }
   ```
3. Save the file and restart Claude Desktop.
4. You can now query CockroachDB documentation directly in Claude Desktop.

### Other MCP clients

For other MCP-compatible clients, use the following server configuration:

**Server URL**: `https://cockroachdb.mcp.kapa.ai`

**Generic configuration format**:

```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
{
  "mcpServers": {
    "cockroachdb-docs": {
      "url": "https://cockroachdb.mcp.kapa.ai"
    }
  }
}
```

Consult your client's documentation for specific configuration instructions.

## Authenticated endpoint for automation

For self-hosted CockroachDB customers who want to integrate the Docs MCP Server into custom agents or automation workflows, an authenticated endpoint is available. This endpoint requires your <InternalLink path="licensing-faqs#obtain-a-license">CockroachDB license key</InternalLink>.

<Note>
  The authenticated endpoint is currently available to self-hosted CockroachDB customers.
</Note>

### Configuration

Use the following endpoint with your <InternalLink path="licensing-faqs#obtain-a-license">CockroachDB license key</InternalLink>:

**Server URL**: `https://docs-mcp.cockroachlabs.com/mcp`

**Generic configuration format**:

```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}}
{
  "mcpServers": {
    "cockroachdb-docs": {
      "url": "https://docs-mcp.cockroachlabs.com/mcp",
      "headers": {
        "Authorization": "Bearer {YOUR_LICENSE_KEY}"
      }
    }
  }
}
```

Replace `\{YOUR_LICENSE_KEY\}` with your CockroachDB license key.

### Authentication errors (401)

If you receive a `401 Unauthorized` error, check the following:

1. Verify your license key is correct. Refer to the <InternalLink path="licensing-faqs#obtain-a-license">licensing FAQ</InternalLink> for details on obtaining your key.
2. Check that the `Authorization` header is formatted as `Bearer \{YOUR_LICENSE_KEY\}` (note the space after `Bearer`).
3. Ensure your license has not expired.
4. If you recently received your license, it may take up to 24 hours to be activated in our system.

## Capabilities

Once connected, your AI assistant can answer questions about CockroachDB directly from the official documentation. Example queries include:

### Multi-region configuration

* "How do I set up a multi-region CockroachDB cluster?"
* "What are the best practices for configuring region survival goals?"
* "Show me how to implement follow-the-workload patterns"

### Performance optimization

* "What are the recommended techniques for optimizing query performance?"
* "How do I identify and resolve hot spots in my cluster?"
* "Explain the best practices for index design in CockroachDB"

### Security features

* "How do I configure TLS/SSL encryption for my cluster?"
* "What are the steps to implement role-based access control?"
* "Show me how to set up audit logging in CockroachDB"

### SQL syntax and features

* "What's the syntax for creating a changefeed?"
* "How do I use window functions in CockroachDB?"
* "Explain the differences between JSONB operators in CockroachDB"

### Troubleshooting

* "How do I diagnose and fix connection refused errors?"
* "What steps should I take when encountering transaction retry errors?"
* "How do I investigate and resolve node liveness issues?"

### Operations and maintenance

* "What's the recommended backup strategy for production clusters?"
* "How do I perform a rolling upgrade of my cluster?"
* "Show me the best practices for monitoring CockroachDB"

## Troubleshooting

### Connection issues

If your AI assistant cannot connect to the CockroachDB documentation:

1. Verify your internet connection.
2. Check that the MCP server URL is correctly configured.
3. Restart your AI assistant application.
4. Ensure you have the latest version of your AI assistant.

### No results

If queries return no results:

1. Try rephrasing your question to be more specific.
2. Include "CockroachDB" in your query for better context.
3. Check the [CockroachDB documentation](/docs) directly to verify the information exists.

### Configuration not working

If the configuration doesn't seem to take effect:

1. Ensure the configuration file is saved in the correct location.
2. Check for JSON syntax errors in your configuration.
3. Fully quit and restart your application (not just reload).
4. For Claude Desktop: Verify that `npx` is available in your system `PATH`.

## Feedback and support

For issues or feedback about the CockroachDB Docs MCP Server, join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community).

## See also

* [Model Context Protocol](https://modelcontextprotocol.io/)