项目简介

Couchbase MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器，它允许大型语言模型 (LLM) 通过工具直接与 Couchbase Capella 集群进行交互。通过此服务器，LLM 可以利用自然语言无缝地查询 Bucket、执行 CRUD 操作、运行 N1QL 查询以及管理数据。

主要功能点

Couchbase 数据库集成: 连接 Couchbase Capella 集群，为 LLM 提供数据访问能力。
资源管理: 通过工具操作 Couchbase 中的 Bucket、Scope 和 Collection。
数据操作: 支持文档的创建、读取、更新和删除 (CRUD) 操作，以及批量文档操作。
查询能力: 允许 LLM 执行 N1QL 查询，从 Couchbase 数据库中检索信息。
索引管理: 支持索引的创建、列出和删除，优化查询性能。
工具注册: 注册了多种工具，方便 LLM 调用执行各种 Couchbase 操作。

安装步骤

环境准备:
- 确保已安装 Node.js 16 或更高版本。
- 确保已拥有 Couchbase Capella 集群。
- 推荐使用 Claude Desktop 客户端。

下载仓库:

git clone https://github.com/Aniket310101/MCP-Server-Couchbase.git
cd MCP-Server-Couchbase

安装依赖:
```
npm install
```

配置环境变量:

在项目根目录下创建 '.env' 文件，并填入您的 Couchbase 连接信息：

COUCHBASE_URL=您的_Couchbase_连接_URL
COUCHBASE_USERNAME=您的_Couchbase_用户名
COUCHBASE_PASSWORD=您的_Couchbase_密码
COUCHBASE_BUCKET=您的_Bucket_名称

请替换上述占位符为您实际的 Couchbase 连接信息。

构建项目:
```
npm run build
```

服务器配置

要将 Couchbase MCP 服务器集成到 MCP 客户端（例如 Claude Desktop），您需要配置客户端的 MCP 服务器设置。以下是 Claude Desktop 客户端的配置示例，您需要将其添加到 Claude Desktop 的配置文件 'claude_desktop_config.json' 中。

配置文件路径:

Windows: '%APPDATA%/Claude/claude_desktop_config.json'
MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'

配置内容 (JSON 格式):

{
  "mcpServers": {
    "couchbase": {
      "command": "node",
      "args": ["path/to/MCP-Server-Couchbase/dist/index.js"],
      "env": {
        "COUCHBASE_URL": "<Couchbase 连接 URL>",  // 替换为您的 Couchbase 连接 URL
        "COUCHBASE_BUCKET": "<Bucket 名称>",    // 替换为您的 Bucket 名称
        "COUCHBASE_USERNAME": "<Couchbase 用户名>", // 替换为您的 Couchbase 用户名
        "COUCHBASE_PASSWORD": "<Couchbase 密码>"  // 替换为您的 Couchbase 密码
      }
    }
  }
}

请注意：

'"path/to/MCP-Server-Couchbase/dist/index.js"' 需要替换为您的 'MCP-Server-Couchbase' 项目 'dist/index.js' 文件的实际路径。
'<Couchbase 连接 URL>'、'<Bucket 名称>'、'<Couchbase 用户名>'、'<Couchbase 密码>' 需要替换为您的 Couchbase Capella 集群的真实连接信息。这些信息与您在 '.env' 文件中配置的信息一致。
'"couchbase"' 是您为该 MCP 服务器自定义的名称，在 Claude 中用于标识和调用该服务器的工具。

基本使用方法

重启客户端: 完成配置后，重启您的 MCP 客户端 (例如 Claude Desktop)，使配置生效。
开始对话: 在客户端中，您可以开始与 LLM 的对话，并使用自然语言指示 LLM 调用 Couchbase 相关的工具。例如：
- “列出所有数据库 bucket”
- “创建一个名为 '用户' 的 scope 和一个名为 '用户资料' 的 collection”
- “查询最近 30 天注册的用户”
- “创建一个用户文档，名字是 '张三'，邮箱是 '[email protected]'”
LLM 将会理解您的指令，并调用 Couchbase MCP 服务器提供的工具来执行相应的数据库操作，并将结果返回给您。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息