Couchbase

🚀 Couchbase MCP 服務器

模型上下文協議 (MCP) 是一種用於處理大型語言模型 (LLMs) 與外部系統之間交互的協議。本項目使用 Couchbase Node.js SDK 實現了一個 Couchbase MCP 服務器，讓 MCP 客戶端（如 Claude Desktop）能夠對 Couchbase Capella 集群執行自然語言查詢。

🚀 快速開始

藉助此服務器，您可以使用以下命令：

• Show me the results of SELECT * FROM my_bucket LIMIT 10
• Execute this query: SELECT name, age FROM users WHERE active = true
• Get me the latest 5 documents from my_bucket
• Summarize the latest 5 orders from the orders bucket for me

✨ 主要特性

Couchbase 查詢工具

• 工具名稱：query-couchbase
• 描述：在您的 Couchbase Capella 集群上執行 SQL++ 查詢語句。
• 用法：調用時，服務器將使用 Couchbase Node.js SDK 執行提供的 SQL++ 查詢並返回結果。

📦 安裝指南

1. 克隆倉庫並安裝依賴項：

git clone git@github.com:hummusonrails/couchbase-mcp-server.git
cd couchbase-mcp-server
npm install

2. 在根目錄下創建一個 .env 文件，並添加您的 Couchbase 連接字符串、用戶名和密碼：

COUCHBASE_CONNECTION_STRING=couchbases://your-cluster.cloud.couchbase.com
COUCHBASE_USERNAME=your_username
COUCHBASE_PASSWORD=your_password

請參考 .env.sample 文件以獲取所需的環境變量。 3. 構建項目：

npm run build

4. 使用 Stdio 傳輸運行服務器：

npx couchbase-mcp-server

⚠️ 重要提示

MCP 服務器使用 StdioServerTransport，因此它通過標準輸入/輸出進行通信。請確保您的 MCP 客戶端（例如 Claude Desktop）配置為連接到本地 MCP 服務器。請按照 Claude Desktop 文檔 配置您的 MCP 客戶端以連接到本地服務器。

💻 使用示例

基礎用法

下圖展示了 MCP 服務器在與 Claude Desktop 客戶端交互時的工作情況。用戶以純英語形式提出一般性請求，MCP 服務器將其轉換為 SQL++ 查詢，並在 Couchbase Capella 集群上執行。結果以可讀格式返回給用戶。

🔧 技術細節

開發

要在本地工作：

1. 安裝依賴項：

npm install
npm run build

2. 使用 MCP 客戶端測試服務器： 啟動您的 MCP 客戶端（例如 Claude Desktop），配置其連接到並使用示例查詢調用工具。
3. 調試 所有日誌消息發送到 stderr，以確保 stdout 僅包含 MCP 協議 JSON。檢查日誌以獲取詳細連接和錯誤消息。

🤝 貢獻

歡迎貢獻！請隨意提交拉取請求或打開問題提出您的建議。對於任何更改，請遵循項目的代碼風格。

📄 許可證

此項目根據 MIT 許可證發佈。有關詳細信息，請參閱 LICENSE 文件。