Documentation: cratedb-mcp has been released

[amotl]

After releasing cratedb-mcp, let's adjust a few docs.

[coderabbitai]

Walkthrough

This update standardizes the installation and usage instructions for the CrateDB MCP server by removing explicit Git URL references and replacing them with the official package name. Documentation and metadata are updated to point to the official CrateDB documentation, and example commands are simplified to use the new conventions.

Changes

File(s)	Change Summary
cratedb_toolkit/query/mcp/registry.py	Updated requirements for cratedb_mcp server from a Git URL to the package name; removed issues field; updated example command.
doc/query/mcp/landscape.md, doc/query/mcp/sandbox.md	Updated documentation to use official documentation URLs; simplified installation and run instructions; updated example commands.

Possibly related PRs

• MCP: Improve documentation #407: Adds example usage commands and metadata fields (including example and issues) to the same cratedb_mcp server in the registry, directly modifying the same server's metadata and documentation.

Poem

🐇
A hop and a skip, the URLs are gone,
Now "cratedb-mcp" is what we hop on!
Docs are refreshed, commands are concise,
Simpler instructions—oh, isn’t that nice?
With every command, a bunny’s delight,
Installation’s easy, and everything’s right!
🥕

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f5be676 and c4582c2.

📒 Files selected for processing (3)

• cratedb_toolkit/query/mcp/registry.py (2 hunks)
• doc/query/mcp/landscape.md (1 hunks)
• doc/query/mcp/sandbox.md (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• doc/query/mcp/sandbox.md

🚧 Files skipped from review as they are similar to previous changes (2)

• doc/query/mcp/landscape.md
• cratedb_toolkit/query/mcp/registry.py

⏰ Context from checks skipped due to timeout of 90000ms (14)

• GitHub Check: Generic: Python 3.12 on OS ubuntu-latest
• GitHub Check: PyMongo: Python 3.12 on OS ubuntu-latest
• GitHub Check: Generic: Python 3.9 on OS ubuntu-latest
• GitHub Check: Generic: Python 3.8 on OS ubuntu-latest
• GitHub Check: Kinesis: Python 3.12 on OS ubuntu-latest
• GitHub Check: Kinesis: Python 3.9 on OS ubuntu-latest
• GitHub Check: CFR: Python 3.12 on OS ubuntu-latest
• GitHub Check: CFR for OS windows-latest
• GitHub Check: Cloud: Python 3.13 on OS ubuntu-latest
• GitHub Check: build-and-test
• GitHub Check: CFR: Python 3.9 on OS ubuntu-latest
• GitHub Check: CFR for OS ubuntu-latest
• GitHub Check: CFR for OS macos-latest
• GitHub Check: CFR for OS macos-13

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch cratedb-mcp-real
• Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

cratedb_toolkit/query/mcp/registry.py (1)

33-33: Example now uses explicit serve subcommand
The invocation is updated correctly. For consistency with user-facing docs, consider updating the homepage field from the GitHub repository to the official CrateDB documentation URL.

Apply this diff to update the homepage link:

@@ -23,1 +23,1 @@
-        homepage="https://github.com/crate/cratedb-mcp",
+        homepage="https://cratedb.com/docs/guide/integrate/mcp/cratedb-mcp.html",

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 554146f and f5be676.

📒 Files selected for processing (3)

• cratedb_toolkit/query/mcp/registry.py (2 hunks)
• doc/query/mcp/landscape.md (1 hunks)
• doc/query/mcp/sandbox.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (14)

• GitHub Check: Generic: Python 3.12 on OS ubuntu-latest
• GitHub Check: PyMongo: Python 3.12 on OS ubuntu-latest
• GitHub Check: Generic: Python 3.9 on OS ubuntu-latest
• GitHub Check: PyMongo: Python 3.9 on OS ubuntu-latest
• GitHub Check: Generic: Python 3.8 on OS ubuntu-latest
• GitHub Check: Kinesis: Python 3.12 on OS ubuntu-latest
• GitHub Check: Kinesis: Python 3.9 on OS ubuntu-latest
• GitHub Check: CFR: Python 3.12 on OS ubuntu-latest
• GitHub Check: CFR for OS windows-latest
• GitHub Check: build-and-test
• GitHub Check: Cloud: Python 3.13 on OS ubuntu-latest
• GitHub Check: CFR for OS ubuntu-latest
• GitHub Check: CFR for OS macos-latest
• GitHub Check: CFR for OS macos-13

🔇 Additional comments (5)

doc/query/mcp/sandbox.md (2)

44-44: Simplified command invocation is clear and accurate
The example now correctly uses uvx cratedb-mcp serve instead of a Git URL. Ensure the backslash continuation and jq pipe remain properly formatted when rendered.

---

115-115: Updated link to official CrateDB documentation
The [cratedb-mcp] reference now points to the official CrateDB guide. Please verify that this URL is live and consistent with other documentation references.

cratedb_toolkit/query/mcp/registry.py (1)

22-22: Requirements field correctly references the released package
Replacing the Git URL with "cratedb-mcp" aligns with the published package name. Confirm the PyPI package identifier matches.

doc/query/mcp/landscape.md (2)

12-15: Standardized installation and run instructions
The homepage URL, install, and run commands have been updated to use official documentation and package names. Ensure these instructions reflect the latest CLI behavior and that the link remains correct.

---

20-21: Example invocation updated to include serve
The example snippet now cleanly shows uvx cratedb-mcp serve. Verify the markdown renders properly and the example has been tested against the current version of uvx.