🗄️ Couchbase MCP Server for LLMs

这是一个模型上下文协议（MCP）服务器，使LLMs能够直接与Capella集群上的Couchbase数据库交互。通过自然语言查询存储桶、执行CRUD操作、运行N1QL查询并管理数据。

🚀 快速开始

1. 前提条件

   • Node.js 16或更高版本
   • 在Capella上运行的Couchbase实例
   • Claude桌面应用程序

2. 安装

   可以通过两种方式安装Couchbase MCP Server：

   方案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
   

3. 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密码>"
         }
       }
     }
   }
   

4. 验证连接

   • 重启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进行交互的例子：

1. 列出所有存储桶：

   能否显示数据库中所有可用的存储桶？
   

2. 创建一个范围和集合：

   创建一个名为“users”的新范围，并在其中创建一个名为“profiles”的集合
   

3. 查询文档：

   查找过去30天内注册的所有用户
   

4. 创建文档：

   创建一个新的用户文档，姓名为“John Doe”，电子邮件为“john@example.com”
   

🤝 贡献

欢迎贡献！请随时提交Pull Request。

🛡️ 安全评估徽章（MseeP.ai）