Enable MCP endpoint for Kapa AI widget #21596
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed:
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
kikiya
approved these changes
Dec 12, 2025
- Add search-as-you-type with Algolia autocomplete - Integrate 'Ask AI' button per Kapa guide - Enable search mode in widget (Chat + Search tabs) - Add MCP dropdown in navigation
…chdb/docs into enable-kapa-mcp-endpoint
- 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
rmloveland
approved these changes
Dec 18, 2025
Contributor
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
Overall LGTM, couple suggestions and some small nits to fix
src/current/docs-mcp-integration.md
Outdated
|
|
||
| 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 |
Contributor
There was a problem hiding this comment.
IMO this section on building one's own MCP can be removed, it splits the focus of the page from the setup instructions for our MCP server
src/current/docs-mcp-integration.md
Outdated
| 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. |
Contributor
There was a problem hiding this comment.
Suggest making "Model Context Protocol" in parens a link to https://modelcontextprotocol.io/introduction
| ### ChatGPT Desktop | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| MCP support for ChatGPT Desktop is coming soon. Check back for updates. |
Contributor
There was a problem hiding this comment.
wild that they still don't have this
src/current/docs-mcp-integration.md
Outdated
| 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 |
Contributor
There was a problem hiding this comment.
suggest wrapping PATH in backticks for code font
src/current/docs-mcp-integration.md
Outdated
| 3. Search for "Claude MCP" | ||
| 4. Add the following to your MCP configuration: | ||
|
|
||
| ```json |
Contributor
There was a problem hiding this comment.
this JSON block needs some indentation in order for the numbered list to render properly. Right now the numbering stops at 4 and restarts at 1 after the code block. I think 4 spaces should work
src/current/docs-mcp-integration.md
Outdated
| 2. Navigate to MCP Servers configuration | ||
| 3. Add the CockroachDB Docs server: | ||
|
|
||
| ```json |
Contributor
There was a problem hiding this comment.
same comment as elsewhere re: the code block needs indentation to render properly (try 4 spaces)
src/current/docs-mcp-integration.md
Outdated
| 2. Navigate to **Models** → **Model Context Protocol** | ||
| 3. Add the following configuration: | ||
|
|
||
| ```json |
Contributor
There was a problem hiding this comment.
same comment as elsewhere re: the code block needs indentation for the numbered list to render properly (try 4 spaces)
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.
- 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'
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Test plan