article
README
🚀 用于大语言模型(LLMs)的 Couchbase MCP 服务器
Couchbase MCP 服务器是一款模型上下文协议(MCP)服务器,它能让大语言模型(LLMs)直接与 Capella 集群上的 Couchbase 数据库进行交互。借助该服务器,用户可以通过自然语言查询存储桶、执行 CRUD 操作、运行 N1QL 查询以及管理数据。
🚀 快速开始
1. 先决条件
- Node.js 16 或更高版本。
- 正在运行的 Couchbase 实例(基于 Capella)。
- Claude Desktop 应用程序。
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 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 连接字符串>",
"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 Desktop。
- 此时,Couchbase MCP 服务器应该已成功集成。
✨ 主要特性
以下是该服务器支持的一些操作:
list buckets:列出所有存储桶。describe bucket <name>:描述指定存储桶的详细信息。create bucket <name> <type>:创建新存储桶。delete bucket <name>:删除指定存储桶。query <sql-query>:执行 N1QL 查询。
🔧 技术细节
安全考量
- 环境变量:敏感信息(如密码)应通过环境变量提供,而不是硬编码,以提高安全性。
- 反向代理:在生产环境中,建议使用反向代理(如 Nginx)来处理 HTTPS 请求,并限制对 MCP 服务器的访问,增强服务器的安全性和稳定性。
💻 使用示例
基础用法
# 列出所有存储桶
list buckets
# 描述指定存储桶
describe bucket my_bucket
# 创建新存储桶
create bucket my_new_bucket Couchbase
# 删除存储桶
delete bucket old_bucket
# 执行 N1QL 查询
query SELECT * FROM my_bucket LIMIT 10
🤝 贡献
我们欢迎社区的贡献!如果您发现任何问题或有任何改进建议,请访问我们的 GitHub 仓库:MCP-Server-Couchbase。
感谢您的支持和帮助,让我们一起使这个项目更加完善!
微信扫一扫