🗄️ Couchbase MCP 服务器，用于 LLM

一个模型上下文协议 (MCP) 服务器，使 LLM 能够直接与 Capella 集群上的 Couchbase 数据库进行交互。通过自然语言无缝查询存储桶、执行 CRUD 操作、执行 N1QL 查询以及管理数据。

🚀 快速开始

1. 前提条件

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

2. 安装

   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
   

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. 列出所有存储桶：

   Could you show me all available buckets in the database?
   

   (你能展示数据库中所有可用的存储桶吗？)

2. 创建一个作用域和集合：

   Create a new scope called "users" and a collection called "profiles" in it
   

   (创建一个名为 "users" 的新作用域，并在其中创建一个名为 "profiles" 的集合)

3. 查询文档：

   Find all users who signed up in the last 30 days
   

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

4. 创建一个文档：

   Create a new user document with name "John Doe" and email "john@example.com"
   

   (创建一个新的用户文档，名称为 "John Doe"，电子邮件为 "john@example.com")

🤝 贡献

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