Robertoamoreno Couchdb MCP Server

🚀 CouchDB-MCP-Server

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

このサーバーは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：インデックスを作成するフィールドの配列
  • 効率的なクエリを実現するための新しいインデックスを作成します。

• deleteMangoIndex - Mangoインデックスを削除します。

  • 必須パラメータ：
    • dbName：データベース名
    • designDoc：デザインドキュメント名
    • indexName：インデックス名
  • 指定されたインデックスを削除します。

• listIndexes - すべてのインデックスをリストします。

  • データベース内のすべてのインデックスの情報を返します。

バージョンサポート

このサーバーは、CouchDBのバージョンに応じて異なる機能を有効にします。

• CouchDB 2.x以降のバージョンで動作します。
• 検出されたCouchDBのバージョンに基づいて、対応する機能を自動的に有効にします。

設定

以下の環境変数を使用してサーバーを設定します。

COUCHDB_URL=http://localhost:5984
COUCHDB_VERSION=3.0.1

デフォルトでは、サーバーはローカルで実行されているCouchDBインスタンスに接続します。

📦 インストール

依存関係のインストール

npm install

ビルド

npm run build

テストの実行

npm test

デバッグ

以下のコマンドを使用してデバッグツールを起動します。

npm run debug

Smithery経由でのインストール

Smitheryプラットフォームで以下のコマンドを使用してサーバーをインストールします。

smith install @robertoamoreno/couchdb-mcp-server

エラー処理

このサーバーには強力なエラー処理機能が備わっており、一般的なシナリオをカバーしています。

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

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