Aniket310101 MCP Server Couchbase

🚀 クイックスタート

🔍 概要

このドキュメントでは、Couchbase MCP サーバーを使用して、LLMs を Capella クラスタ上の Couchbase データベースと直接やり取りさせる方法を説明します。自然言語でバケットのクエリ、CRUD 操作、N1QL クエリの実行、データの管理を行うことができます。

📋 前提条件

• Node.js 16 以上
• Capella ベースの稼働中の Couchbase インスタンス
• Claude Desktop アプリケーション

📦 インストール

Couchbase MCP サーバーは、2 つの方法でインストールできます。

オプション 1：NPX を使用する（推奨）

NPX を使用すると、最も速くインストールできます。

npx -y @couchbasedatabase/couchbase-mcp

オプション 2：手動インストール

プロジェクトをクローンして実行する場合は、以下の手順を実行します。

# リポジトリをクローンする
git clone https://github.com/Aniket310101/MCP-Server-Couchbase.git
cd MCP-Server-Couchbase

# 依存関係をインストールする
npm install

# プロジェクトをビルドする
npm run build

🔌 Claude Desktop との統合

Claude Desktop の設定ファイルに以下の設定を追加します。

• Windows：%APPDATA%/Claude/claude_desktop_config.json
• MacOS：~/Library/Application Support/Claude/claude_desktop_config.json

オプション 1：パッケージを使用してインストールする

{
  "mcpServers": {
    "couchbase": {
      "command": "npx",
      "args": ["-y", "@couchbasedatabase/couchbase-mcp"],
      "env": {
        "COUCHBASE_URL": "<COUCHBASE 接続文字列>",
        "COUCHBASE_BUCKET": "<バケット名>",
        "COUCHBASE_USERNAME": "<Couchbase ユーザー名>",
        "COUCHBASE_PASSWORD": "<Couchbase パスワード>"
      }
    }
  }
}

オプション 2：手動でインストールする

{
  "mcpServers": {
    "couchbase": {
      "command": "node",
      "args": ["path/to/MCP-Server-Couchbase/dist/index.js"],
      "env": {
        "COUCHBASE_URL": "<COUCHBASE 接続文字列>",
        "COUCHBASE_BUCKET": "<バケット名>",
        "COUCHBASE_USERNAME": "<Couchbase ユーザー名>",
        "COUCHBASE_PASSWORD": "<Couchbase パスワード>"
      }
    }
  }
}

✅ 接続の検証

• Claude Desktop を再起動します。
• これで、Couchbase MCP サーバーツールがダイアログで使用できるようになります。

✨ 主な機能

🛠️ 基本操作

• query：N1QL クエリを実行する
• listBuckets：すべての利用可能なバケットをリストする

🔍 スコープ管理

• createScope：バケット内に新しいスコープを作成する
• deleteScope：既存のスコープを削除する
• listScopes：すべてのスコープをリストする

📄 コレクションとドキュメント操作

• createCollection：スコープ内に新しいコレクションを作成する
• deleteCollection：コレクションを削除する
• getDocument：ドキュメントを取得する
• .getDocumentByQuery：クエリを使用してドキュメントを取得する
• upsertDocument：ドキュメントを挿入または更新する
• replaceDocument：ドキュメントを置き換える
• removeDocument：ドキュメントを削除する

🔎 クエリと検索

• queryDocuments：SQL を使用してドキュメントをクエリする
• searchCollection：コレクション内でドキュメントを検索する
• getSearchIndexingStatus：インデックスの状態を取得する
• getIndexFields：インデックスのフィールドを取得する
• getFilterDefinitions：フィルター定義を取得する
• getSortSpecifications：ソート仕様を取得する

🔒 セキュリティに関する考慮事項

• 環境変数を使用して機密情報を保存します。

export COUCHBASE_URL=your_cluster_url
export COUCHBASE_USERNAME=your_username
export COUCHBASE_PASSWORD=your_password

• 本番環境では、Nginx などのリバースプロキシを使用して Couchbase クラスタを保護します。

💻 使用例

スコープとコレクションの作成

# スコープを作成する
createScope(bucket_name, scope_name)

# コレクションを作成する
createCollection(bucket_name, scope_name, collection_name)

ドキュメント操作

# ドキュメントを挿入する
upsertDocument(bucket_name, scope_name, collection_name, document_id, document_body)

# ドキュメントを取得する
getDocument(bucket_name, scope_name, collection_name, document_id)

# ドキュメントを削除する
removeDocument(bucket_name, scope_name, collection_name, document_id)

クエリと検索

# N1QL クエリを実行する
queryDocuments(bucket_name, query_string)

# コレクションを検索する
searchCollection(bucket_name, scope_name, collection_name, search_query)

🤝 貢献

コミュニティからの貢献を歓迎します！GitHub リポジトリ を参照して、オープンソースプロジェクトに参加し、プルリクエストを送信してください。