Couchdb MCP Server

🚀 CouchDB-MCP-Server

CouchDB-MCP-Server是一個用於與CouchDB交互的模型上下文協議（MCP）服務器。它基於TypeScript構建，為管理CouchDB數據庫和文檔提供了一系列實用工具，能讓AI助手通過簡單接口與CouchDB進行交互。

🚀 快速開始

服務器需要CouchDB連接URL和版本信息，可通過環境變量提供：

COUCHDB_URL=http://username:password@localhost:5984
COUCHDB_VERSION=1.7.2

你可以在項目根目錄創建一個.env文件，將上述配置信息寫入其中。若未提供相關信息，默認的連接地址為 http://localhost:5984。

✨ 主要特性

工具

基礎工具（所有CouchDB版本）

• createDatabase - 創建新的CouchDB數據庫
  • 必需參數：dbName
  • 功能：若指定的數據庫不存在，則創建該數據庫。
• listDatabases - 列出所有CouchDB數據庫
  • 返回值：一個包含所有數據庫名稱的數組。
• deleteDatabase - 刪除CouchDB數據庫
  • 必需參數：dbName
  • 功能：移除指定的數據庫及其包含的所有文檔。
• createDocument - 創建新文檔或更新現有文檔
  • 必需參數：
    • dbName：數據庫名稱
    • docId：文檔ID
    • data：文檔數據（JSON對象）。若進行更新操作，需包含 _rev 字段以指定當前文檔版本。
  • 返回值：
    • 若創建新文檔，返回文檔ID和新修訂版。
    • 若更新文檔，返回文檔ID和更新後的修訂版。
    • 該方法會根據是否存在 _rev 字段自動判斷是創建還是更新操作。
• getDocument - 獲取數據庫中的文檔
  • 必需參數：
    • dbName：數據庫名稱
    • docId：文檔ID
  • 返回值：文檔內容。

Mango查詢工具（CouchDB 3.x+僅限）

• createMangoIndex - 創建新的Mango索引
  • 必需參數：
    • dbName：數據庫名稱
    • indexName：索引名稱
    • fields：要索引的字段數組
  • 功能：創建新的Mango索引，以實現高效的查詢操作。
• deleteMangoIndex - 刪除Mango索引
  • 必需參數：
    • dbName：數據庫名稱
    • designDoc：設計文檔名稱
    • indexName：索引名稱
  • 功能：移除現有的Mango索引。
• listMangoIndexes - 列出數據庫中的所有Mango索引
  • 必需參數：dbName（數據庫名稱）
  • 返回值：有關所有索引的信息。
• findDocuments - 使用Mango查詢文檔
  • 必需參數：
    • dbName：數據庫名稱
    • query：Mango查詢對象
  • 功能：執行CouchDB的Mango查詢語法進行文檔查詢。

版本支持

服務器會自動檢測CouchDB版本，並根據版本情況啟用相應功能：

• 所有版本：支持基本的數據庫和文檔操作。
• CouchDB 3.x+：支持Mango查詢（包括索引創建和查詢操作）。

📦 安裝指南

通過Smithery安裝

若要通過Smithery為Claude Desktop自動安裝couchdb-mcp-server，可執行以下命令：

npx -y @smithery/cli install @robertoamoreno/couchdb-mcp-server --client claude

若要與Claude Desktop一起使用，需添加服務器配置：

• 在MacOS中，配置文件路徑為：~/Library/Application Support/Claude/claude_desktop_config.json
• 在Windows中，配置文件路徑為：%APPDATA%\Claude\claude_desktop_config.json

配置內容如下：

{
  "servers": {
    "couchdb-mcp-server": {
      "url": "http://localhost:4000",
      "username": "admin",
      "password": "password"
    }
  }
}

💻 使用示例

開發

安裝依賴

npm install

構建服務器

npm run build

帶有自動重建的開發

npm run watch

🔧 技術細節

服務器具備強大的錯誤處理功能，可針對以下常見情況進行處理：

• 無效的數據庫名稱或文檔ID
• 數據庫已存在/不存在
• 連接問題
• 認證失敗
• 無效的文檔數據

所有錯誤都會通過MCP協議以適當的狀態碼和消息格式返回。