Couchbase Guru

io.github.Couchbase-Ecosystem由 GitHub 账号 Couchbase-Ecosystem 发布v0.1.0更新于 Oct 24, 2026

Search the Couchbase documentation from your MCP client via a hosted documentation agent.

已验证STDIO仅桌面知识与记忆开发者工具

概览

AI 生成的概览

让助手通过查询托管的文档 RAG 代理来回答 Couchbase 产品、SDK 和教程相关问题。

可以做什么
只提供一个工具 ask_couchbase_docs,把问题转发给托管的检索增强文档代理,并返回自然语言答案及文档来源链接。问题需要完整自洽,因为后端不保留对话历史。它只与文档代理通信,不接触任何 Couchbase 集群或你的数据。
适用场景
适合在 MCP 客户端内直接查询 Couchbase Server、SDK、服务或教程细节的场景。它面向文档查询,而不是查询或管理你自己的 Couchbase 数据。
运行要求
需要 Python 3.10 或更高版本、已安装 uv/uvx,以及 Claude Desktop、Cursor、VS Code、Windsurf 或 JetBrains IDE 等 MCP 客户端。默认以 stdio 在本地运行;可选 HTTP 模式使用 CB_MCP_HOST 和 CB_MCP_PORT。可选 CB_AGENT_BASE_URL 指向自建代理,否则使用公共代理。无需 Couchbase 凭据。
安装前请注意
问题会发送到托管的文档代理,默认是受公平使用限流约束的公共后端;可通过 CB_AGENT_BASE_URL 自建以避开。服务器会在 User-Agent 头中发送假名设备标识:stdio 下为随机生成的每用户 id,HTTP 下为连接 IP 的加盐单向哈希。CB_AGENT_IP_SALT 是用于该哈希的密钥盐。HTTP 模式不支持授权。答案由大模型生成,可能不准确。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Couchbase Guru,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

Couchbase Guru MCP Server

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.

[License] [Python 3.10+] [PyPI version]

No Couchbase cluster or credentials required. The server talks only to the documentation agent backend, not to your data.

Tool

Tool NameDescription
ask_couchbase_docsAnswer 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?").

Prerequisites

Configuration

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.

Running from PyPI

json
{  "mcpServers": {    "couchbase-guru": {      "command": "uvx",      "args": ["couchbase-guru"]    }  }}

If you already have other MCP servers configured, add this entry to the existing mcpServers object.

Running from Source

Clone the repository:

bash
git clone https://github.com/Couchbase-Ecosystem/couchbase-guru.git

Then point your MCP client at it:

json
{  "mcpServers": {    "couchbase-guru": {      "command": "uv",      "args": [        "--directory",        "path/to/cloned/repo/couchbase-guru/",        "run",        "src/mcp_server.py"      ]    }  }}

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 ArgumentEnvironment VariableDescriptionDefault
--transportCB_MCP_TRANSPORTTransport mode: stdio or httpstdio
--hostCB_MCP_HOSTHost for HTTP transport mode127.0.0.1
--portCB_MCP_PORTPort for HTTP transport mode8000
--agent-base-urlCB_AGENT_BASE_URLBase 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-saltCB_AGENT_IP_SALTSecret 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:

bash
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:

bash
uvx couchbase-guru --agent-base-url https://your-agent.example.com

Rate limiting & privacy

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).

Client-specific configuration

Claude Desktop
  1. Edit the configuration file (see the MCP quickstart guide):
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  2. Add the configuration to the mcpServers section.
  3. Restart Claude Desktop.

Logs: ~/Library/Logs/Claude (macOS) or %APPDATA%\Claude\Logs (Windows).

Cursor
  1. In Cursor, go to Cursor Settings > Tools & Integrations > MCP Tools.
  2. Add the configuration manually, or use the one-click Install in Cursor link.
  3. Save, then refresh to confirm the server is enabled.

Logs: in the bottom panel, click Output and select Cursor MCP from the dropdown.

Windsurf Editor
  1. Open Command Palette > Windsurf MCP Configuration Panel (or Settings > Advanced > Cascade > Model Context Protocol (MCP) Servers).
  2. Click Add Server > Add custom server and add the configuration.
  3. Save, then refresh to confirm the server is enabled.

See the Windsurf MCP documentation for details.

VS Code
  1. Create .vscode/mcp.json in your workspace (or run MCP: Open User Configuration for a global config).

  2. VS Code uses servers as the top-level key (not mcpServers):

    json
    {  "servers": {    "couchbase-guru": {      "command": "uvx",      "args": ["couchbase-guru"]    }  }}
  3. Once saved, use the inline action list to Start/Stop/manage the server.

See the VS Code MCP docs for details.

JetBrains IDEs
  1. Install the AI Assistant or Junie plugin.
  2. Navigate to Settings > Tools > AI Assistant or Junie > MCP Server.
  3. Click "+", add the configuration, and click Save, then Apply.

Logs: Help > Show Log in Finder (Explorer) > mcp > couchbase-guru.

Streamable HTTP transport mode

The server can run in Streamable HTTP mode so multiple clients can connect to one instance. Check that your MCP client supports this transport first.

bash
uvx couchbase-guru --transport=http --port=8000

The server will be available at http://localhost:8000/mcp:

json
{  "mcpServers": {    "couchbase-guru-http": {      "url": "http://localhost:8000/mcp"    }  }}

This mode does not include authorization support.

Docker

Build the image:

bash
docker build -t couchbase-guru .

Run it (stdio by default; no credentials needed):

json
{  "mcpServers": {    "couchbase-guru-docker": {      "command": "docker",      "args": ["run", "--rm", "-i", "couchbase-guru"]    }  }}

For HTTP transport, publish the port and set the transport:

bash
docker run --rm -i \  -e CB_MCP_TRANSPORT=http \  -e CB_MCP_HOST=0.0.0.0 \  -e CB_MCP_PORT=8000 \  -p 8000:8000 \  couchbase-guru

Risks associated with LLMs

  • 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):

bash
uv sync --extra devuv run pytest tests/

Integration tests exercise the tool end-to-end against a live agent backend and are opt-in:

bash
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).

bash
# Clone and set upgit clone https://github.com/Couchbase-Ecosystem/couchbase-guru.gitcd couchbase-guru
# Install with development dependenciesuv sync --extra dev
# Install pre-commit hooksuv 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.

来源:README.md,提交 095d55f

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.1.0最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分