关于 Couchbase
Couchbase 是一款 MCP 服务,允许 MCP 客户端通过自然语言请求查询 Couchbase Capella 集群。它使用 Couchbase Node.js SDK 执行 SQL++ 查询并返回结果。
主要功能
- 01执行 SQL++ 查询
- 02连接 Couchbase Capella 集群
- 03向 MCP 客户端返回查询结果
适用场景
- 01按请求检索文档
- 02使用筛选条件查询指定字段
- 03获取存储桶中的最新文档
MCP 相关
它向 MCP 客户端提供 `query-couchbase` 工具,用于在 Couchbase Capella 集群执行 SQL++ 语句并返回结果。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
Couchbase MCP 服务
Model Context Protocol(MCP)是一种协议,用于处理大模型(LLM)与外部系统之间的交互。本仓库使用 Couchbase Node.js SDK 实现了 Couchbase MCP 服务,使 MCP 客户端(例如 Claude Desktop)能够对 Couchbase Capella 集群执行自然语言查询。
使用此服务,你可以发出如下命令:
Show me the results of SELECT * FROM my_bucket LIMIT 10Execute this query: SELECT name, age FROM users WHERE active = trueGet me the latest 5 documents from my_bucketSummarize the latest 5 orders from the orders bucket for me
示例
以下截图展示了 MCP 服务与 Claude Desktop 客户端协同工作的场景。用户用自然语言提出一般性请求,MCP 服务将其转换为 SQL++ 查询,并在 Couchbase Capella 集群上执行。随后,查询结果会以易读的格式返回给用户。
设置
- 克隆仓库并安装依赖:
git clone [email protected]:hummusonrails/couchbase-mcp-server.git
cd couchbase-mcp-server
npm install
- 在根目录中创建
.env文件,并添加 Couchbase 连接字符串、用户名和密码:
COUCHBASE_CONNECTION_STRING=couchbases://your-cluster.cloud.couchbase.com
COUCHBASE_USERNAME=your_username
COUCHBASE_PASSWORD=your_password
所需的环境变量请参阅 .env.sample 文件。
- 构建项目:
npm run build
- 使用 Stdio 传输运行服务:
npx couchbase-mcp-server
说明
MCP 服务使用 StdioServerTransport,因此通过标准输入/输出进行通信。请确保你的 MCP 客户端(例如 Claude Desktop)已配置为使用本地 MCP 服务。 请按照 Claude Desktop 文档配置 MCP 客户端,以连接到本地服务。
功能
Couchbase 查询工具
- 工具名称:
query-couchbase - 描述: 在你的 Couchbase Capella 集群上执行 SQL++ 查询语句。
- 用法:调用时,服务将使用 Couchbase Node.js SDK 执行所提供的 SQL++ 查询并返回结果。
开发
如需在本地开发此项目:
- 安装依赖:
npm install
npm run build
- 使用 MCP 客户端测试服务:
启动已配置为连接并调用该工具的 MCP 客户端(例如 Claude Desktop),并使用示例查询。
- 调试
所有日志消息都会发送到 stderr,以确保 stdout 仅包含 MCP 协议 JSON。请查看日志,了解详细的连接和错误信息。
贡献
欢迎贡献!请随时提交拉取请求,或提出问题并分享你的建议。进行任何更改时,请确保遵循项目的代码风格。
许可证
本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。