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 連接字符串>",
        "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 密碼>"
      }
    }
  }
}

驗證連接

• 重新啟動 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 倉庫 中查看我們的開源項目並提交拉取請求。