Dhartunian Cockroachdb MCP Server

🚀 CockroachDB 管理制御プレーン (MCP) サーバー

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

🚀 クイックスタート

CockroachDB 管理制御プレーン (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 for Desktop を使用する場合

1. Claude for 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 for Desktop を再起動します。

Cline を使用する場合

1. Cline の設定ファイルを開きます（拡張機能の設定から「MCP サーバー」を見つけ、「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 クラスターノードの情報を表示してください」

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

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

トラブルシューティング

• 接続問題が発生した場合は、データベースの資格情報を確認し、CockroachDB インスタンスにアクセス可能であることを確認してください。
• 設定ファイルが正しいことを検証し、特にパスとパラメーターの位置を確認してください。
• データベースインスタンスへの接続を妨げるファイアウォールやネットワーク制限がないか確認してください。