Cockroachdb MCP Server

🚀 CockroachDB MCP サーバー

この MCP サーバーは、CockroachDB インスタンスに接続し、データベースとテーブルのスキーマをリソースとして公開し、SQL クエリをツールとして実行し、クエリ分析のヒントを提供します。

✨ 主な機能

リソース

• postgres://{host}/databases/{database} - 特定のデータベースの情報を取得します。
• postgres://{host}/databases/{database}/tables/{table}/schema - 特定のテーブルのスキーマを取得します。
• postgres://{host}/cluster-metadata/{resource} - クラスターのメタデータを取得します（認証トークンが必要です）。
  • 現在サポートされているもの：nodes - クラスターノードの情報

ツール

• query - SQL クエリを実行し、実行計画分析オプション付きです。

📦 インストール

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

   pnpm install
   

3. プロジェクトをビルドします：

   npx tsc
   

⚠️ 重要提示

ローカルで MCP サーバーを使用する前に、必ず tsc でプロジェクトをビルドする必要があります。

📚 ドキュメント

設定

サーバーは、コマンドライン引数としてデータベース URL を必要とし、管理インターフェイスのエンドポイントにアクセスするための認証トークンをオプションで受け取ります。

node dist/server.js postgres://user:password@host:port/database [auth_token]

認証トークンは、クラスターメタデータリソースにアクセスするために使用されます。

Claude Desktop での使用方法

1. Claude Desktop アプリの設定を開きます：

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

2. サーバーの設定を追加します：

{
  "mcpServers": {
    "cockroachdb": {
      "command": "node",
      "args": [
        "/path/to/cockroachdb-mcp-server/dist/server.js", 
        "postgres://user:password@host:port/database",
        "your_auth_token"
      ]
    }
  }
}

3. Claude Desktop を再起動します。

Cline での使用方法

1. Cline の設定ファイルを開き、拡張機能設定から「MCP サーバー」を選択します。
2. サーバーの設定を追加します：

{
  "mcpServers": {
    "crdb": {
      "command": "node",
      "args": [
        "/path/to/cockroachdb-mcp-server/dist/server.js",
        "postgres://root@127.0.0.1:26257/testdb",
        "your_auth_token"
      ]
    }
  }
}

3. Cline を再起動するか、新しいセッションを開始します。

クエリの例

以下は、Claude に実行させることができるクエリの例です。

1. 「私の CockroachDB インスタンスにはどのようなデータベースがありますか？」
2. 「'testdb' データベースの 'users' テーブルのスキーマを表示できますか？」
3. 「私のデータベースでこのクエリを実行してください：SELECT * FROM users LIMIT 10」
4. 「このクエリをデバッグし、改善提案をしてください：SELECT * FROM orders WHERE customer_id = 123」
5. 「私のクラスターのすべてのノードの情報を表示してください」

セキュリティに関する注意事項

• データベースへのアクセスを設定する際は注意してください。データのクエリのみが必要な場合は、読み取り専用ユーザーを使用することを検討してください。
• 認証トークンは、CockroachDB 管理インターフェイス API にアクセスするために使用されます。このトークンを安全に保管してください。

トラブルシューティング

• 接続問題が発生した場合は、データベースの資格情報を確認し、CockroachDB インスタンスがあなたのマシンからアクセス可能であることを確認してください。
• SQL エラーの場合は、サーバーのログを確認して詳細なエラーメッセージを取得してください。
• Claude がサーバーを認識できない場合は、設定ファイルが正しい形式であり、server.js ファイルへのパスが正しいことを確認してください。
• クラスターメタデータリソースの場合は、有効な認証トークンを提供し、管理インターフェイスがポート 8080 でアクセス可能であることを確認してください。