Couchbase

🚀 Couchbase MCP サーバー

モデルコンテキストプロトコル (MCP) は、大規模言語モデル (LLMs) と外部システム間のインタラクションを処理するためのプロトコルです。このリポジトリでは、Couchbase Node.js SDK を使用して Couchbase MCP サーバーを実装しています。これにより、MCP クライアント（例：Claude Desktop）が Couchbase Capella クラスタに対して自然言語クエリを実行できます。

このサーバーを使うことで、以下のようなコマンドを使用できます。

• Show me the results of SELECT * FROM my_bucket LIMIT 10
• Execute this query: SELECT name, age FROM users WHERE active = true
• Get me the latest 5 documents from my_bucket
• Summarize the latest 5 orders from the orders bucket for me

🚀 クイックスタート

モデルコンテキストプロトコル (MCP) は、大規模言語モデル (LLMs) と外部システム間のインタラクションを処理するためのプロトコルです。このリポジトリの Couchbase MCP サーバーを使えば、MCP クライアントが Couchbase Capella クラスタに自然言語クエリを実行できます。

✨ 主な機能

Couchbase クエリツール

• ツール名: query-couchbase
• 説明: Couchbase Capella クラスタ上で SQL++ クエリ文を実行します。
• 使い方: 呼び出されると、サーバーは Couchbase Node.js SDK を使って提供された SQL++ クエリを実行し、結果を返します。

📦 インストール

1. リポジトリをクローンし、依存関係をインストールします。

git clone git@github.com:hummusonrails/couchbase-mcp-server.git
cd couchbase-mcp-server
npm install

2. ルートディレクトリに .env ファイルを作成し、Couchbase の接続文字列、ユーザー名、パスワードを追加します。

COUCHBASE_CONNECTION_STRING=couchbases://your-cluster.cloud.couchbase.com
COUCHBASE_USERNAME=your_username
COUCHBASE_PASSWORD=your_password

必要な環境変数については、.env.sample ファイルを参照してください。 3. プロジェクトをビルドします。

npm run build

4. Stdio トランスポートを使ってサーバーを起動します。

npx couchbase-mcp-server

⚠️ 重要提示

MCP サーバーは StdioServerTransport を使用しているため、標準入出力を介して通信します。MCP クライアント（例：Claude Desktop）がローカルの MCP サーバーに接続するように設定してください。 Claude Desktop ドキュメント に従って、MCP クライアントをローカルサーバーに接続するように設定してください。

💻 使用例

基本的な使用法

下の図は、MCP サーバーが Claude Desktop クライアントとやり取りする際の動作を示しています。ユーザーが英語で一般的な要求を行うと、MCP サーバーがそれを SQL++ クエリに変換し、Couchbase Capella クラスタ上で実行します。結果は読みやすい形式でユーザーに返されます。

🔧 開発

ローカルで作業するには、以下の手順を行います。

1. 依存関係をインストールします。

npm install
npm run build

2. MCP クライアントを使ってサーバーをテストします。 MCP クライアント（例：Claude Desktop）を起動し、接続設定を行い、サンプルクエリを使ってツールを呼び出します。
3. デバッグ すべてのログメッセージは stderr に送信され、stdout には MCP プロトコル JSON のみが含まれるようになっています。詳細な接続情報やエラーメッセージはログを確認してください。

🤝 コントリビューション

コントリビューションを歓迎します！自由にプルリクエストを送信したり、問題を開いて提案を投稿してください。変更を加える場合は、プロジェクトのコードスタイルに従ってください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細については、LICENSE ファイルを参照してください。