Couchdb MCP Server

🚀 CouchDB-MCP-Server

CouchDBとのインタラクションを行うためのモデルコンテキストプロトコル（MCP）サーバーです。

これはTypeScriptベースのMCPサーバーで、CouchDBデータベースとドキュメントを管理するツールを提供します。これにより、AIアシスタントは簡単なインターフェースを通じてCouchDBとやり取りすることができます。

✨ 主な機能

ツール

基本ツール（すべての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

📚 設定

サーバーにはCouchDBの接続URLとバージョンが必要です。これらは環境変数を通じて提供できます。

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

プロジェクトのルートディレクトリに.envファイルを作成し、この設定を含めることができます。提供されない場合、デフォルトは http://localhost:5984 です。

🚫 エラー処理

サーバーには強力なエラー処理機能が含まれており、一般的なケースに対応しています。

• 無効なデータベース名またはドキュメントID
• データベースが既に存在する/存在しない
• 接続問題
• 認証失敗
• 無効なドキュメントデータ

すべてのエラーは、MCPプロトコルを通じて適切なステータスコードとメッセージ形式で返されます。