From b6fe607315c4fc221bd520c207236d4e880fc7dd Mon Sep 17 00:00:00 2001 From: ebembi-crdb Date: Thu, 11 Dec 2025 21:30:10 +0530 Subject: [PATCH 1/7] Enable MCP endpoint for Kapa AI widget Add data-mcp-enabled and data-mcp-server-url attributes to the Kapa widget script to enable public MCP (Model Context Protocol) access. This allows users to interact with CockroachDB documentation through MCP-compatible AI tools without requiring authentication. --- src/current/_includes/head.html | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/current/_includes/head.html b/src/current/_includes/head.html index 7815053ec23..2974db452cf 100755 --- a/src/current/_includes/head.html +++ b/src/current/_includes/head.html @@ -153,6 +153,8 @@ data-modal-disclaimer="This AI bot is experimental. Don't rely on it for production workloads. Always consult the official CockroachDB documentation. Interactions with this AI bot may be monitored or recorded, and your use of the AI bot is subject to the Cockroach Labs' [Terms of Use](https://www.cockroachlabs.com/website-terms-of-use/) and [Privacy policy](https://www.cockroachlabs.com/privacy/)." data-modal-y-offset="12vh" data-modal-z-index="1000" + data-mcp-enabled="true" + data-mcp-server-url="https://cockroachdb.mcp.kapa.ai" > +
+ + + + // Make handleAskAI globally available + window.handleAskAI = handleAskAI; + \ No newline at end of file From 6fca79978fed1d748d3bff5ad9b658bccb04bf63 Mon Sep 17 00:00:00 2001 From: ebembi-crdb Date: Thu, 18 Dec 2025 14:19:05 +0530 Subject: [PATCH 3/7] Add CockroachDB Docs MCP documentation page - Create documentation page explaining the MCP server integration - Add setup instructions for multiple platforms (Cursor, VS Code, Claude Desktop, etc.) - Include example queries and troubleshooting section - Follow Kapa's documentation structure with CockroachDB-specific content --- src/current/docs-mcp-integration.md | 193 ++++++++++++++++++++++++++++ 1 file changed, 193 insertions(+) create mode 100644 src/current/docs-mcp-integration.md diff --git a/src/current/docs-mcp-integration.md b/src/current/docs-mcp-integration.md new file mode 100644 index 00000000000..bcf96095451 --- /dev/null +++ b/src/current/docs-mcp-integration.md @@ -0,0 +1,193 @@ +--- +title: CockroachDB Docs MCP +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +The CockroachDB Docs MCP (Model Context Protocol) server enables AI assistants like Claude Desktop, Cursor, and VS Code to access CockroachDB documentation directly. This allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Create your own MCP + +Want to build your own MCP server? Check out the [MCP documentation](https://modelcontextprotocol.io/introduction) to get started. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + +```json +{ + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } +} +``` + +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + +```json +{ + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } +} +``` + +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + +```json +{ + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } +} +``` + +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 +{ + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## What you can do + +Once connected, you can ask your AI assistant questions about CockroachDB and get answers directly from the official documentation. Here are some example queries: + +### 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system PATH + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file From 767def83dbae9444fdfed234762851bf95f52d84 Mon Sep 17 00:00:00 2001 From: ebembi-crdb Date: Thu, 18 Dec 2025 22:26:48 +0530 Subject: [PATCH 4/7] Address PR review comments for docs-mcp-integration.md Based on feedback from @rmloveland: - Remove "Create your own MCP" section to maintain focus on setup instructions - Add link to Model Context Protocol documentation in the introduction - Fix code block indentation in numbered lists to preserve list continuity - Fixed indentation for Cursor, VS Code, Claude Code, and Claude Desktop sections - Removed blank lines between list items and code blocks - Added 4-space indentation to code blocks within list items - Wrap PATH in backticks for proper code formatting in troubleshooting section These changes improve document clarity, formatting consistency, and numbered list rendering. --- src/current/docs-mcp-integration.md | 88 +++++++++++++---------------- 1 file changed, 38 insertions(+), 50 deletions(-) diff --git a/src/current/docs-mcp-integration.md b/src/current/docs-mcp-integration.md index bcf96095451..cb9082cd7f6 100644 --- a/src/current/docs-mcp-integration.md +++ b/src/current/docs-mcp-integration.md @@ -5,11 +5,7 @@ toc: true docs_area: reference --- -The CockroachDB Docs MCP (Model Context Protocol) server enables AI assistants like Claude Desktop, Cursor, and VS Code to access CockroachDB documentation directly. This allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. - -## Create your own MCP - -Want to build your own MCP server? Check out the [MCP documentation](https://modelcontextprotocol.io/introduction) to get started. +The CockroachDB Docs MCP ([Model Context Protocol](https://modelcontextprotocol.io/introduction)) server enables AI assistants like Claude Desktop, Cursor, and VS Code to access CockroachDB documentation directly. This allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. ## Setup @@ -20,18 +16,16 @@ Connect your AI assistant to CockroachDB documentation by configuring the MCP se 1. Open Cursor Settings (⌘+,) 2. Navigate to **Models** → **Model Context Protocol** 3. Add the following configuration: - -```json -{ - "mcpServers": { - "cockroachdb-docs": { - "command": "npx", - "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } } - } -} -``` - + ``` 4. Restart Cursor to apply the configuration 5. You can now ask questions about CockroachDB documentation directly in Cursor @@ -41,18 +35,16 @@ Connect your AI assistant to CockroachDB documentation by configuring the MCP se 2. Open VS Code Settings (⌘+,) 3. Search for "Claude MCP" 4. Add the following to your MCP configuration: - -```json -{ - "claude.mcpServers": { - "cockroachdb-docs": { - "command": "npx", - "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } } - } -} -``` - + ``` 5. Reload VS Code window (⌘+R) 6. The CockroachDB documentation is now available through Claude in VS Code @@ -61,18 +53,16 @@ Connect your AI assistant to CockroachDB documentation by configuring the MCP se 1. Open Claude Code settings 2. Navigate to MCP Servers configuration 3. Add the CockroachDB Docs server: - -```json -{ - "mcpServers": { - "cockroachdb-docs": { - "command": "npx", - "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } } - } -} -``` - + ``` 4. Restart Claude Code 5. CockroachDB documentation is now accessible in your Claude Code environment @@ -90,18 +80,16 @@ MCP support for ChatGPT Desktop is coming soon. Check back for updates. - **Linux**: `~/.config/Claude/claude_desktop_config.json` 2. Add the CockroachDB Docs MCP server to your configuration: - -```json -{ - "mcpServers": { - "cockroachdb-docs": { - "command": "npx", - "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } } - } -} -``` - + ``` 3. Save the file and restart Claude Desktop 4. You can now query CockroachDB documentation directly in Claude Desktop @@ -177,7 +165,7 @@ 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. Verify that `npx` is available in your system PATH +4. Verify that `npx` is available in your system `PATH` ## Feedback and Support From 355e8a4d715bdacaef805ad0bc638f400b0c448a Mon Sep 17 00:00:00 2001 From: ebembi-crdb Date: Fri, 19 Dec 2025 23:05:13 +0530 Subject: [PATCH 5/7] Finalize CockroachDB Docs MCP Server integration - Rename page title from 'CockroachDB Docs MCP' to 'CockroachDB Docs MCP Server' - Polish content for clarity and consistency - Add 'Docs MCP Server' to Reference section sidebar in all versions (v21.2-v26.1) - Position entry after Cluster API in navigation hierarchy - Update section header from 'What you can do' to 'Capabilities' --- .../_includes/v21.2/sidebar-data/reference.json | 6 ++++++ .../_includes/v22.1/sidebar-data/reference.json | 6 ++++++ .../_includes/v22.2/sidebar-data/reference.json | 6 ++++++ .../_includes/v23.1/sidebar-data/reference.json | 6 ++++++ .../_includes/v23.2/sidebar-data/reference.json | 6 ++++++ .../_includes/v24.1/sidebar-data/reference.json | 6 ++++++ .../_includes/v24.2/sidebar-data/reference.json | 6 ++++++ .../_includes/v24.3/sidebar-data/reference.json | 6 ++++++ .../_includes/v25.1/sidebar-data/reference.json | 6 ++++++ .../_includes/v25.2/sidebar-data/reference.json | 6 ++++++ .../_includes/v25.3/sidebar-data/reference.json | 6 ++++++ .../_includes/v25.4/sidebar-data/reference.json | 6 ++++++ .../_includes/v26.1/sidebar-data/reference.json | 6 ++++++ src/current/docs-mcp-integration.md | 10 +++++----- 14 files changed, 83 insertions(+), 5 deletions(-) diff --git a/src/current/_includes/v21.2/sidebar-data/reference.json b/src/current/_includes/v21.2/sidebar-data/reference.json index 9de10775d12..fee6cf50bc9 100644 --- a/src/current/_includes/v21.2/sidebar-data/reference.json +++ b/src/current/_includes/v21.2/sidebar-data/reference.json @@ -1687,6 +1687,12 @@ "https://www.cockroachlabs.com/docs/api/cloud/v1" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Logging", "items": [ diff --git a/src/current/_includes/v22.1/sidebar-data/reference.json b/src/current/_includes/v22.1/sidebar-data/reference.json index 560f98af121..55b89032a4a 100644 --- a/src/current/_includes/v22.1/sidebar-data/reference.json +++ b/src/current/_includes/v22.1/sidebar-data/reference.json @@ -1795,6 +1795,12 @@ "https://www.cockroachlabs.com/docs/api/cloud/v1" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Logging", "items": [ diff --git a/src/current/_includes/v22.2/sidebar-data/reference.json b/src/current/_includes/v22.2/sidebar-data/reference.json index 49952f96087..5a6c452b7e5 100644 --- a/src/current/_includes/v22.2/sidebar-data/reference.json +++ b/src/current/_includes/v22.2/sidebar-data/reference.json @@ -1687,6 +1687,12 @@ "https://www.cockroachlabs.com/docs/api/cloud/v1" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Logging", "items": [ diff --git a/src/current/_includes/v23.1/sidebar-data/reference.json b/src/current/_includes/v23.1/sidebar-data/reference.json index 2dfaf93caf5..7a51665f5b4 100644 --- a/src/current/_includes/v23.1/sidebar-data/reference.json +++ b/src/current/_includes/v23.1/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v23.2/sidebar-data/reference.json b/src/current/_includes/v23.2/sidebar-data/reference.json index 6c192e4a264..b4c2bd3c366 100644 --- a/src/current/_includes/v23.2/sidebar-data/reference.json +++ b/src/current/_includes/v23.2/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v24.1/sidebar-data/reference.json b/src/current/_includes/v24.1/sidebar-data/reference.json index d42c2bd32a9..b4cb937a5cd 100644 --- a/src/current/_includes/v24.1/sidebar-data/reference.json +++ b/src/current/_includes/v24.1/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v24.2/sidebar-data/reference.json b/src/current/_includes/v24.2/sidebar-data/reference.json index 4691b0f8bbd..84c7f3aca56 100644 --- a/src/current/_includes/v24.2/sidebar-data/reference.json +++ b/src/current/_includes/v24.2/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v24.3/sidebar-data/reference.json b/src/current/_includes/v24.3/sidebar-data/reference.json index 4691b0f8bbd..84c7f3aca56 100644 --- a/src/current/_includes/v24.3/sidebar-data/reference.json +++ b/src/current/_includes/v24.3/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v25.1/sidebar-data/reference.json b/src/current/_includes/v25.1/sidebar-data/reference.json index 3c6fe8ff298..f0fd0625e54 100644 --- a/src/current/_includes/v25.1/sidebar-data/reference.json +++ b/src/current/_includes/v25.1/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v25.2/sidebar-data/reference.json b/src/current/_includes/v25.2/sidebar-data/reference.json index efcd6296367..b2c3171dc7e 100644 --- a/src/current/_includes/v25.2/sidebar-data/reference.json +++ b/src/current/_includes/v25.2/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v25.3/sidebar-data/reference.json b/src/current/_includes/v25.3/sidebar-data/reference.json index efcd6296367..b2c3171dc7e 100644 --- a/src/current/_includes/v25.3/sidebar-data/reference.json +++ b/src/current/_includes/v25.3/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v25.4/sidebar-data/reference.json b/src/current/_includes/v25.4/sidebar-data/reference.json index efcd6296367..b2c3171dc7e 100644 --- a/src/current/_includes/v25.4/sidebar-data/reference.json +++ b/src/current/_includes/v25.4/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/_includes/v26.1/sidebar-data/reference.json b/src/current/_includes/v26.1/sidebar-data/reference.json index efcd6296367..b2c3171dc7e 100644 --- a/src/current/_includes/v26.1/sidebar-data/reference.json +++ b/src/current/_includes/v26.1/sidebar-data/reference.json @@ -67,6 +67,12 @@ "https://www.cockroachlabs.com/docs/api/cluster/v2" ] }, + { + "title": "Docs MCP Server", + "urls": [ + "/${VERSION}/docs-mcp-integration.html" + ] + }, { "title": "Cluster Settings", "urls": [ diff --git a/src/current/docs-mcp-integration.md b/src/current/docs-mcp-integration.md index cb9082cd7f6..467807e2977 100644 --- a/src/current/docs-mcp-integration.md +++ b/src/current/docs-mcp-integration.md @@ -1,11 +1,11 @@ --- -title: CockroachDB Docs MCP +title: CockroachDB Docs MCP Server summary: Connect to CockroachDB documentation directly from your IDE or AI assistant toc: true docs_area: reference --- -The CockroachDB Docs MCP ([Model Context Protocol](https://modelcontextprotocol.io/introduction)) server enables AI assistants like Claude Desktop, Cursor, and VS Code to access CockroachDB documentation directly. This allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. ## Setup @@ -111,9 +111,9 @@ Generic configuration format: Consult your client's documentation for specific configuration instructions. -## What you can do +## Capabilities -Once connected, you can ask your AI assistant questions about CockroachDB and get answers directly from the official documentation. Here are some example queries: +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?" @@ -169,7 +169,7 @@ If the configuration doesn't seem to take effect: ## Feedback and Support -For issues or feedback about the CockroachDB Docs MCP server: +For issues or feedback about the CockroachDB Docs MCP Server: - Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) - For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) - Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help From 2d5bcedfbb0266ece162b7a9349fa58268dc7a7d Mon Sep 17 00:00:00 2001 From: ebembi-crdb Date: Fri, 19 Dec 2025 23:57:30 +0530 Subject: [PATCH 6/7] Add docs-mcp-integration.md to version directories to fix build The sidebar entries were added in the previous commit, but the build was failing because the actual page files didn't exist in the version directories. This adds the MCP documentation page to all version directories (v21.2 through v26.1) to match the sidebar entries and fix the build errors. --- src/current/v21.2/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v22.1/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v22.2/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v23.1/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v23.2/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v24.1/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v24.2/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v24.3/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v25.1/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v25.2/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v25.3/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v25.4/docs-mcp-integration.md | 181 ++++++++++++++++++++++ src/current/v26.1/docs-mcp-integration.md | 181 ++++++++++++++++++++++ 13 files changed, 2353 insertions(+) create mode 100644 src/current/v21.2/docs-mcp-integration.md create mode 100644 src/current/v22.1/docs-mcp-integration.md create mode 100644 src/current/v22.2/docs-mcp-integration.md create mode 100644 src/current/v23.1/docs-mcp-integration.md create mode 100644 src/current/v23.2/docs-mcp-integration.md create mode 100644 src/current/v24.1/docs-mcp-integration.md create mode 100644 src/current/v24.2/docs-mcp-integration.md create mode 100644 src/current/v24.3/docs-mcp-integration.md create mode 100644 src/current/v25.1/docs-mcp-integration.md create mode 100644 src/current/v25.2/docs-mcp-integration.md create mode 100644 src/current/v25.3/docs-mcp-integration.md create mode 100644 src/current/v25.4/docs-mcp-integration.md create mode 100644 src/current/v26.1/docs-mcp-integration.md diff --git a/src/current/v21.2/docs-mcp-integration.md b/src/current/v21.2/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v21.2/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v22.1/docs-mcp-integration.md b/src/current/v22.1/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v22.1/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v22.2/docs-mcp-integration.md b/src/current/v22.2/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v22.2/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v23.1/docs-mcp-integration.md b/src/current/v23.1/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v23.1/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v23.2/docs-mcp-integration.md b/src/current/v23.2/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v23.2/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v24.1/docs-mcp-integration.md b/src/current/v24.1/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v24.1/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v24.2/docs-mcp-integration.md b/src/current/v24.2/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v24.2/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v24.3/docs-mcp-integration.md b/src/current/v24.3/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v24.3/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v25.1/docs-mcp-integration.md b/src/current/v25.1/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v25.1/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v25.2/docs-mcp-integration.md b/src/current/v25.2/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v25.2/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v25.3/docs-mcp-integration.md b/src/current/v25.3/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v25.3/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v25.4/docs-mcp-integration.md b/src/current/v25.4/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v25.4/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file diff --git a/src/current/v26.1/docs-mcp-integration.md b/src/current/v26.1/docs-mcp-integration.md new file mode 100644 index 00000000000..467807e2977 --- /dev/null +++ b/src/current/v26.1/docs-mcp-integration.md @@ -0,0 +1,181 @@ +--- +title: CockroachDB Docs MCP Server +summary: Connect to CockroachDB documentation directly from your IDE or AI assistant +toc: true +docs_area: reference +--- + +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. This integration allows you to get instant, context-aware answers about CockroachDB without leaving your development environment. + +## Setup + +Connect your AI assistant to CockroachDB documentation by configuring the MCP server. Choose your platform below for specific instructions. + +### Cursor + +1. Open Cursor Settings (⌘+,) +2. Navigate to **Models** → **Model Context Protocol** +3. Add the following configuration: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Cursor to apply the configuration +5. You can now ask questions about CockroachDB documentation directly in Cursor + +### VS Code + +1. Install the [Claude for VS Code](https://marketplace.visualstudio.com/items?itemName=Anthropic.claude) extension +2. Open VS Code Settings (⌘+,) +3. Search for "Claude MCP" +4. Add the following to your MCP configuration: + ```json + { + "claude.mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +5. Reload VS Code window (⌘+R) +6. The CockroachDB documentation is now available through Claude in VS Code + +### Claude Code + +1. Open Claude Code settings +2. Navigate to MCP Servers configuration +3. Add the CockroachDB Docs server: + ```json + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "https://cockroachdb.mcp.kapa.ai"] + } + } + } + ``` +4. Restart Claude Code +5. CockroachDB documentation is now accessible in your Claude Code environment + +### ChatGPT Desktop + +{{site.data.alerts.callout_info}} +MCP support for ChatGPT Desktop is coming soon. Check back for updates. +{{site.data.alerts.end}} + +### 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 + { + "mcpServers": { + "cockroachdb-docs": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything", "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 + +For other MCP-compatible clients, use the following server configuration: + +**Server URL**: `https://cockroachdb.mcp.kapa.ai` + +Generic configuration format: +```json +{ + "servers": [{ + "name": "cockroachdb-docs", + "url": "https://cockroachdb.mcp.kapa.ai" + }] +} +``` + +Consult your client's documentation for specific configuration instructions. + +## 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: `https://cockroachdb.mcp.kapa.ai` +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](https://www.cockroachlabs.com/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. Verify that `npx` is available in your system `PATH` + +## Feedback and Support + +For issues or feedback about the CockroachDB Docs MCP Server: +- Report documentation issues on [GitHub](https://github.com/cockroachdb/docs/issues) +- For MCP-specific problems, check [Kapa AI support](https://docs.kapa.ai) +- Join the [CockroachDB Community Slack](https://www.cockroachlabs.com/join-community/) for help + +## See Also + +- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/) +- [Model Context Protocol](https://modelcontextprotocol.io/) +- [Kapa AI Documentation](https://docs.kapa.ai) \ No newline at end of file From e0ee1a2e05073d4367a0d02ad085a01ba14d73b7 Mon Sep 17 00:00:00 2001 From: ebembi-crdb Date: Mon, 22 Dec 2025 15:01:39 +0530 Subject: [PATCH 7/7] Restrict Kapa widget search to docs source only Added data-search-source-ids-include attribute to limit search results to documentation content only, excluding GitHub, blog, and customer sources. --- src/current/_includes/head.html | 1 + 1 file changed, 1 insertion(+) diff --git a/src/current/_includes/head.html b/src/current/_includes/head.html index 529b5016d7e..6b4fe57fa4e 100755 --- a/src/current/_includes/head.html +++ b/src/current/_includes/head.html @@ -161,6 +161,7 @@ data-mcp-enabled="true" data-mcp-server-url="https://cockroachdb.mcp.kapa.ai" data-search-mode-enabled="true" + data-search-source-ids-include="142a5371-2b4f-4d42-91aa-9c18142991d5" data-modal-open-on-command-k="true" >