Couchbase MCP 服务器

模型上下文协议 (MCP) 是一种协议，用于处理大型语言模型 (LLM) 与外部系统之间的交互。 此存储库使用 Couchbase Node.js SDK 实现了 Couchbase MCP 服务器，使 MCP 客户端（例如，Claude Desktop）能够对 Couchbase Capella 集群执行自然语言查询。

使用此服务器，您可以使用以下命令：

• Show me the results of SELECT * FROM my_bucket LIMIT 10 (显示我从 my_bucket 中 SELECT * LIMIT 10 的结果)
• Execute this query: SELECT name, age FROM users WHERE active = true (执行此查询：SELECT name, age FROM users WHERE active = true)
• Get me the latest 5 documents from my_bucket (从 my_bucket 中获取最新的 5 个文档)
• Summarize the latest 5 orders from the orders bucket for me (为我总结 orders bucket 中最新的 5 个订单)

示例

以下屏幕截图显示了 MCP 服务器与 Claude Desktop 客户端一起运行的情况。 用户用简单的英语发出一般请求，MCP 服务器将其转换为 SQL++ 查询，该查询针对 Couchbase Capella 集群执行。 然后，结果以可读的格式返回给用户。

<p> <img src="claude_screenshot.png" alt="MCP 服务器在 Claude 中工作的示例屏幕截图" width="50%"> </p>

设置

1. 克隆存储库并安装依赖项：

git clone git@github.com:hummusonrails/couchbase-mcp-server.git
cd couchbase-mcp-server
npm install

2. 在根目录中创建一个 .env 文件，并添加您的 Couchbase 连接字符串、用户名和密码：

COUCHBASE_CONNECTION_STRING=couchbases://your-cluster.cloud.couchbase.com
COUCHBASE_USERNAME=your_username
COUCHBASE_PASSWORD=your_password

有关必需的环境变量，请参阅 .env.sample 文件。

3. 构建项目：

npm run build

4. 使用 Stdio 传输运行服务器：

npx couchbase-mcp-server

[!NOTE] MCP 服务器使用 StdioServerTransport，因此它通过标准输入/输出进行通信。 确保您的 MCP 客户端（例如，Claude Desktop）配置为使用本地 MCP 服务器。 按照 Claude Desktop 文档 设置 MCP 客户端以连接到本地服务器。

功能

Couchbase 查询工具

• ToolName: query-couchbase
• Description: 在您的 Couchbase Capella 集群上执行 SQL++ 查询语句。
• Usage: 调用时，服务器将使用 Couchbase Node.js SDK 执行提供的 SQL++ 查询并返回结果。

开发

要在本地开发项目：

1. 安装依赖项：

npm install
npm run build

2. 使用 MCP 客户端测试服务器：

启动您的 MCP 客户端（例如，Claude Desktop），配置为连接并使用示例查询调用该工具。

3. 调试

所有日志消息都发送到 stderr，以确保 stdout 仅包含 MCP 协议 JSON。 检查您的日志以获取详细的连接和错误消息。

贡献

欢迎贡献！ 请随时提交拉取请求或提出包含您建议的问题。 对于任何更改，请确保您遵循项目的代码风格。

许可证

该项目已获得 MIT 许可证的许可。 有关详细信息，请参阅 LICENSE 文件。