Couchbase MCP 服务器

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

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

• Show me the results of SELECT * FROM my_bucket LIMIT 10
• Execute this query: SELECT name, age FROM users WHERE active = true
• Get me the latest 5 documents from my_bucket
• Summarize the latest 5 orders from the orders bucket for me

示例

下图展示了 MCP 服务器在与 Claude Desktop 客户端交互时的工作情况。用户以纯英语形式提出一般性请求，MCP 服务器将其转换为 SQL++ 查询，并在 Couchbase Capella 集群上执行。结果以可读格式返回给用户。

安装

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 查询工具

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

开发

要在本地工作：

1. 安装依赖项：

npm install
npm run build

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

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

3. 调试

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

贡献

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

许可证

此项目根据 MIT 许可证发布。有关详细信息，请参阅 LICENSE 文件。