Aniket310101_MCP Server Couchbase

🚀 Couchbase MCP 服务器用于 LLMs

Couchbase MCP 服务器是一款模型上下文协议（MCP）服务器，它能让大语言模型（LLMs）直接与 Capella 集群上的 Couchbase 数据库进行交互。借助该服务器，用户可完全通过自然语言实现查询桶、执行 CRUD 操作、运行 N1QL 查询以及管理数据等功能。

🚀 快速开始

先决条件

• Node.js 16 或更高版本
• 运行中的 Couchbase 实例（基于 Capella）
• Claude Desktop 应用程序

安装

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 Desktop 集成

将以下配置添加到您的 Claude Desktop 配置文件中：

• 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_BUCKET": "<桶名称>",
"COUCHBASE_USERNAME": "",
"COUCHBASE_PASSWORD": ""
}
}
}
}

选项 2：使用手动安装

{
"mcpServers": {
"couchbase": {
"command": "node",
"args": ["path/to/MCP-Server-Couchbase/dist/index.js"],
"env": {
"COUCHBASE_URL": "",
"COUCHBASE_BUCKET": "<桶名称>",
"COUCHBASE_USERNAME": "",
"COUCHBASE_PASSWORD": ""
}
}
}
}

验证连接

• 重新启动 Claude Desktop
• 此时，Couchbase MCP 服务器工具应可在您的对话中使用

✨ 主要特性

基本操作

• query：执行 N1QL 查询
• listBuckets：列出所有可用桶

作用域管理

• createScope：在桶中创建新作用域
• deleteScope：删除现有作用域
• listScopes：列出所有作用域

集合和文档操作

• createCollection：在作用域中创建新集合
• deleteCollection：删除集合
• getDocument：获取文档
• .getDocumentByQuery：通过查询获取文档
• upsertDocument：插入或更新文档
• replaceDocument：替换文档
• removeDocument：删除文档

查询和搜索

• queryDocuments：通过 SQL 查询文档
• searchCollection：在集合中搜索文档
• getSearchIndexingStatus：获取索引状态
• getIndexFields：获取索引字段
• getFilterDefinitions：获取过滤器定义
• getSortSpecifications：获取排序规范

🔧 技术细节

安全考虑

• 使用环境变量存储敏感信息，示例如下：

export COUCHBASE_URL=your_cluster_url
export COUCHBASE_USERNAME=your_username
export COUCHBASE_PASSWORD=your_password

• 在生产环境中使用反向代理（如 Nginx）来保护您的 Couchbase 集群

💻 使用示例

基础用法

创建作用域和集合

# 创建作用域
createScope(bucket_name, scope_name)

# 创建集合
createCollection(bucket_name, scope_name, collection_name)

文档操作

# 插入文档
upsertDocument(bucket_name, scope_name, collection_name, document_id, document_body)

# 获取文档
getDocument(bucket_name, scope_name, collection_name, document_id)

# 删除文档
removeDocument(bucket_name, scope_name, collection_name, document_id)

查询和搜索

# 执行 N1QL 查询
queryDocuments(bucket_name, query_string)

# 搜索集合
searchCollection(bucket_name, scope_name, collection_name, search_query)

🤝 贡献

我们欢迎社区的贡献！请在 GitHub 仓库 中查看我们的开源项目并提交拉取请求。