Skip to content

Docs for CockroachDB MCP Server Phase 1#22885

Open
bsanchez-the-roach wants to merge 4 commits intomainfrom
DOC-15457
Open

Docs for CockroachDB MCP Server Phase 1#22885
bsanchez-the-roach wants to merge 4 commits intomainfrom
DOC-15457

Conversation

@bsanchez-the-roach
Copy link
Contributor

DOC-15457

For now this is just a "Getting Started" guide.

@github-actions
Copy link

Files changed:

@netlify
Copy link

netlify bot commented Feb 27, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 429673b
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69a1d7fe22955300072bf4e2

@netlify
Copy link

netlify bot commented Feb 27, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 429673b
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69a1d7fe33634d0008f3c15d

@netlify
Copy link

netlify bot commented Feb 27, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 3844d75
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69a1d80cd690c800086e85f5

@netlify
Copy link

netlify bot commented Feb 27, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 3844d75
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69a1d80c033eca0008b8d82d

"type": "http",
"url": "https://cockroachlabs.cloud/mcp?cluster_id={your-cluster-id}"
}
~~~
Copy link
Contributor Author

@bsanchez-the-roach bsanchez-the-roach Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be helpful if an engineer could go through and make sure that all eight of these JSON snippets are accurate. I just copied the OAuth ones from the instructions on the cluster connect modal. For the API key ones, I simply added the Authentication header, as in the Claude Code config, but that might not be the right syntax for all of the other tools.

"url": "https://cockroachlabs.cloud/mcp?cluster_id={your-cluster-id}"
}
~~~

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, in the first published version of this document, do we actually want to do JSON snippets or would we rather include the CLI commands for each tool?

3. Find `"mcpServers"`. Include the JSON snippet in the list of MCP servers, replacing the `{your-cluster-id}` and `{your-service-account-api-key}` placeholders.

4. Restart Claude Code.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would also be helpful if, for each of these tools, an engineer could give me the command to run to verify that the server has been added correctly, and (perhaps a separate?) command to verify that the connection is working. For example claude mcp list shows that the server has been added to claude (though I don't know what the command is to verify the connection, if there is one).

@netlify
Copy link

netlify bot commented Feb 27, 2026

Netlify Preview

Name Link
🔨 Latest commit 429673b
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69a1d7fef684c30008635161
😎 Deploy Preview https://deploy-preview-22885--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Feb 27, 2026

Netlify Preview

Name Link
🔨 Latest commit 3844d75
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69a1d80cd3efae0008690bbf
😎 Deploy Preview https://deploy-preview-22885--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant