MCP服务端库
一种模型上下文协议服务器,它使大型语言模型能够通过自然语言直接与Couchbase数据库交互,支持查询存储桶、执行CRUD操作和运行N1QL查询等操作。
MCP 服务配置
复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用
{
"mcpServers": {
"couchbase": {
"args": [
"path/to/MCP-Server-Couchbase/dist/index.js"
],
"command": "node",
"env": {
"COUCHBASE_BUCKET": "\u003cBUCKET NAME\u003e",
"COUCHBASE_PASSWORD": "\u003cCOUCHBASE PASSWORD\u003e",
"COUCHBASE_URL": "\u003cCOUCHBASE CONNECTION STRING\u003e",
"COUCHBASE_USERNAME": "\u003cCOUCHBASE USERNAME\u003e"
}
}
}
}
该服务需要配置环境变量:COUCHBASE_BUCKET、COUCHBASE_PASSWORD、COUCHBASE_URL、COUCHBASE_USERNAME
服务介绍
🗄️ Couchbase MCP 服务器用于大语言模型
一个模型上下文协议(MCP)服务器,使大语言模型能够直接与Capella集群上的Couchbase数据库交互。通过自然语言无缝查询存储桶、执行CRUD操作、执行N1QL查询和管理数据。
🚀 快速开始
-
前提条件
- Node.js 16 或更高版本
- 在Capella上运行的Couchbase实例
- Claude桌面应用程序
-
安装
Couchbase MCP 服务器可以通过两种方式安装:
选项 1:使用 NPX(推荐)
最快的入门方法是使用 NPX:
npx -y @couchbasedatabase/couchbase-mcp选项 2:手动安装
如果您更喜欢克隆并手动运行项目:
# 克隆仓库 git clone https://github.com/Aniket310101/MCP-Server-Couchbase.git cd MCP-Server-Couchbase # 安装依赖项 npm install # 构建项目 npm run build -
Claude 桌面集成
将此配置添加到您的 Claude 桌面配置文件中:
Windows:
%APPDATA%/Claude/claude_desktop_config.json
MacOS:~/Library/Application Support/Claude/claude_desktop_config.json选项 1:包安装
{ "mcpServers": { "couchbase": { "command": "npx", "args": ["-y", "@couchbasedatabase/couchbase-mcp"], "env": { "COUCHBASE_URL": "<COUCHBASE 连接字符串>", "COUCHBASE_BUCKET": "<存储桶名称>", "COUCHBASE_USERNAME": "<COUCHBASE 用户名>", "COUCHBASE_PASSWORD": "<COUCHBASE 密码>" } } } }选项 2:手动安装
{ "mcpServers": { "couchbase": { "command": "node", "args": ["path/to/MCP-Server-Couchbase/dist/index.js"], "env": { "COUCHBASE_URL": "<COUCHBASE 连接字符串>", "COUCHBASE_BUCKET": "<存储桶名称>", "COUCHBASE_USERNAME": "<COUCHBASE 用户名>", "COUCHBASE_PASSWORD": "<COUCHBASE 密码>" } } } } -
验证连接
- 重启 Claude 桌面
- 现在您的对话中应该可以使用 Couchbase MCP 服务器工具了
📝 可用工具
基本操作
query: 执行 N1QL 查询listBuckets: 列出可用的存储桶
范围管理
createScope: 在存储桶中创建一个新的范围deleteScope: 删除现有的范围listScopes: 列出存储桶中的所有范围
集合管理
createCollection: 在范围内创建一个新的集合dropCollection: 从范围中删除一个集合
文档操作
createDocument: 创建一个新的文档getDocument: 通过 ID 检索文档updateDocument: 更新现有文档deleteDocument: 通过 ID 删除文档bulkCreateDocuments: 一次创建多个文档
索引管理
createIndex: 在指定字段上创建新索引createPrimaryIndex: 在集合上创建主索引listIndexes: 列出存储桶中的所有索引dropIndex: 删除现有索引
每个工具都支持可选的 collection 和 scope 参数,用于定位特定的数据容器。
🔒 安全注意事项
- 始终使用环境变量来处理敏感凭据
- 考虑在生产环境中通过反向代理运行服务器
- 根据需要实现适当的访问控制和身份验证
📚 示例
以下是一些使用 MCP 服务器与 Claude 交互的示例:
-
列出所有存储桶:
你能显示数据库中所有可用的存储桶吗? -
创建一个范围和集合:
创建一个名为 "users" 的新范围,并在其中创建一个名为 "profiles" 的集合 -
查询文档:
查找过去 30 天内注册的所有用户 -
创建文档:
创建一个新的用户文档,姓名为 "John Doe",电子邮件为 "john@example.com"
🤝 贡献
欢迎贡献!请随时提交 Pull Request。