couchdb-mcp-server

CouchDBと対話するためのモデルコンテキストプロトコルサーバー

これは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 : インデックスの名前

  • 既存のMangoインデックスを削除します

• listMangoIndexes - データベース内のすべてのMangoインデックスを一覧表示する

  • 必須パラメータ:

    • dbName : データベース名

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

• findDocuments - Mangoクエリを使用してドキュメントをクエリする

  • 必須パラメータ:

    • dbName : データベース名

    • query : Mangoクエリオブジェクト

  • CouchDBのMangoクエリ構文を使用してクエリを実行します

Related MCP server: TDengine Query MCP Server

バージョンサポート

サーバーは CouchDB のバージョンを自動的に検出し、それに応じて機能を有効にします。

• すべてのバージョン: 基本的なデータベースおよびドキュメント操作

• CouchDB 3.x+: Mango クエリのサポート (インデックスとクエリ)

構成

サーバーにはCouchDBの接続URLとバージョンが必要です。これらは環境変数で指定できます。

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

You can create a `.env` file in the project root with this configuration. If not provided, it defaults to `http://localhost:5984`.

## Development

Install dependencies:
```bash
npm install

サーバーを構築します。

npm run build

自動リビルドを使用した開発の場合:

npm run watch

インストール

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

{
  "mcpServers": {
    "couchdb-mcp-server": {
      "command": "/path/to/couchdb-mcp-server/build/index.js",
      "env": {
        "COUCHDB_URL": "http://username:password@localhost:5984"
      }
    }
  }
}

前提条件

• Node.js 14以上

• CouchDBインスタンスの実行

• 認証が有効になっている場合の適切なCouchDB認証情報

デバッグ

MCPサーバーはstdio経由で通信するため、デバッグが困難になる場合があります。パッケージスクリプトとして提供されているMCP Inspectorの使用をお勧めします。

npm run inspector

インスペクターは、ブラウザでデバッグ ツールにアクセスするための URL を提供します。

エラー処理

サーバーには、一般的なシナリオに対応する堅牢なエラー処理機能が含まれています。

• 無効なデータベース名またはドキュメントID

• データベースが既に存在する/存在しない

• 接続の問題

• 認証失敗

• 無効なドキュメントデータ

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