CB_MCP_TRANSPORT — Transport mode for the server (stdio or http). Default is stdio.
CB_MCP_HOST — Host to run the MCP server on (default: 127.0.0.1). Used only for HTTP transport mode.
CB_MCP_PORT — Port to run the MCP server on (default: 8000). Used only for HTTP transport mode.
CB_AGENT_BASE_URL — Base URL of the documentation agent backend. Set this to run against your own self-hosted agent; if unset, the public agent is used.
CB_AGENT_IP_SALT — Secret salt used to pseudonymize client IPs (HTTP transport). Set a shared value for consistent hashing across multiple instances; a local salt is generated when unset.
O Claude Code não tem link de instalação para um comando local. Copie o comando abaixo e execute-o em um terminal.
An MCP server that lets LLMs search the Couchbase documentation from your MCP client. It exposes a single tool, ask_couchbase_docs, which forwards your question to a hosted retrieval-augmented (RAG) documentation agent and returns an answer with source links.
Search the Couchbase documentation from your MCP client via a hosted documentation agent.
No Couchbase cluster or credentials required. The server talks only to the documentation agent backend, not to your data.
Tool
Tool Name
Description
ask_couchbase_docs
Answer a question about any Couchbase product, feature, SDK, service, tutorial, or example by searching the official documentation. Returns a natural-language answer followed by the documentation source URLs.
Ask complete, self-contained questions — the backend has no conversation history, so include the product, version, and language where relevant (e.g. "How do I create a primary index with the Python SDK in Couchbase Server 7.6?").
The server can be run from the prebuilt PyPI package or from source with uv. It works with zero configuration — the public documentation agent is used by default.
path/to/cloned/repo/couchbase-guru/ should be the path to the cloned repository on your machine. Don't forget the trailing slash.
Options
All options are optional and can be set via CLI argument or environment variable:
CLI Argument
Environment Variable
Description
Default
--transport
CB_MCP_TRANSPORT
Transport mode: stdio or http
stdio
--host
CB_MCP_HOST
Host for HTTP transport mode
127.0.0.1
--port
CB_MCP_PORT
Port for HTTP transport mode
8000
--agent-base-url
CB_AGENT_BASE_URL
Base URL of the documentation agent backend. Set this to run against your own self-hosted agent; if unset, the public agent is used.
Public agent
--agent-ip-salt
CB_AGENT_IP_SALT
Secret salt used to pseudonymize client IPs (HTTP transport). Set a shared value for consistent hashing across multiple instances; a local salt is generated when unset.
Auto-generated
Check the installed version with:
uvx couchbase-guru --version
Self-hosting the documentation agent
By default the server uses a shared, public documentation agent, so most users need no setup. If you run your own agent backend, point the server at it:
The public agent applies fair-use rate limits. To support this, the server sends a pseudonymous device identifier to the backend (in the User-Agent header):
stdio: a random id generated once and stored in a per-user file on your machine.
HTTP: a salted, one-way hash of the connecting IP — the raw address is never sent.
No question content or personal data is persisted by the MCP server itself. If you prefer not to share a rate-limit signal, self-host the agent (see above).
The use of large language models and similar technology involves risks, including the potential for inaccurate or harmful outputs.
Couchbase does not review or evaluate the quality or accuracy of such outputs, and such outputs may not reflect Couchbase's views.
You are solely responsible for determining whether to use large language models and related technology, and for complying with any applicable license terms, terms of use, and your organization's policies.
Troubleshooting
Confirm that uv/uvx is installed and on your PATH. You may need to provide an absolute path to uv/uvx in the command field.
If a search times out, the documentation backend may be busy — retry in a moment.
To rule out the public backend, run against your own agent with --agent-base-url.
If running from source after updating the repo, run uv sync to refresh dependencies.
Check your MCP client's logs (locations above) for errors.
Testing
Unit tests run offline (the backend is mocked):
uv sync --extra dev
uv run pytest tests/
Integration tests exercise the tool end-to-end against a live agent backend and are opt-in:
CB_MCP_RUN_INTEGRATION=1 uv run pytest tests/test_docs_tools.py
By default they use the public agent; set CB_AGENT_BASE_URL to target a different backend.
👩💻 Contributing
Contributions are welcome! To report a bug, request a feature, or contribute improvements, open a GitHub issue.
See CONTRIBUTING.md for developer setup (environment with uv, linting/formatting with Ruff, pre-commit hooks, and project structure).
# Clone and set up
git clone https://github.com/Couchbase-Ecosystem/couchbase-guru.git
cd couchbase-guru
# Install with development dependencies
uv sync --extra dev
# Install pre-commit hooks
uv run pre-commit install
📢 Support Policy
We appreciate your interest in this project! It is Couchbase community-maintained, which means it is not officially supported by our support team. Our engineers monitor and maintain this repo and will try to resolve issues on a best-effort basis. Please keep all inquiries within GitHub.
Ainda não há lista de ferramentas. Servidores remotos recebem uma após a primeira verificação de saúde.
Perguntas frequentes
Perguntas
Como instalo Couchbase Guru?
Copie nesta página a configuração stdio para Cursor, Claude Desktop, Claude Code ou VS Code. Ela usa a instalação do publicador, não um proxy do PlugMCP.
Couchbase Guru precisa de uma chave de API?
O publicador lista estas variáveis de ambiente: CB_MCP_TRANSPORT, CB_MCP_HOST, CB_MCP_PORT, CB_AGENT_BASE_URL, CB_AGENT_IP_SALT.
Qual transporte Couchbase Guru usa?
Couchbase Guru roda localmente via stdio.
Quando Couchbase Guru foi verificado pela última vez?
Última verificação: 2026-11-09. Search the Couchbase documentation from your MCP client via a hosted documentation agent.