Couchbase MCP

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
• 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服务器将其转换为针对Couchbase Capella集群执行的SQL++查询。然后，结果以可读格式返回给用户。

设置

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

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

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

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

请参阅 .env.sample 所需环境变量的文件。

1. 构建项目：

npm run build

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

npx couchbase-mcp-server

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

特性

Couchbase查询工具

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

开发中

在当地开展项目：

1. 安装依赖关系：

npm install
npm run build

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

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

1. 调试

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

贡献

欢迎投稿！请随时提交拉取请求或提出建议。对于任何更改，请确保遵循项目的代码样式。

许可证

该项目根据MIT许可证获得许可。请参阅 许可证 文件以获取详细信息。