Cockroachdb MCP Server

🚀 CockroachDB MCP サーバー

このサーバーは、Cursor をベースにした CockroachDB MCP サーバーで、Model Context Protocol (MCP) 規格に基づいて実装されており、CockroachDB データベースと直接やり取りできます。

English | 简体中文

✨ 主な機能

• CockroachDB データベースに接続する
• データベース内のすべてのテーブルを取得する
• テーブル構造情報を取得する
• SQL クエリを実行する
• データベースの状態リソースを提供する
• SQL クエリテンプレートを提供する
• 接続の安定性を確保するための自動再接続機能
• タイムアウトを防止するための接続アクティブ化機能
• プロセスのエレガントな終了処理
• 障害排除のための詳細なログ記録
• 手動での接続切断をサポートする

📦 インストール

Smithery を使用したインストール

Smithery を通じて、Cursor 用の CockroachDB MCP サーバーを自動でインストールします。

npx -y @smithery/cli install @Swayingleaves/cockroachdb-mcp-server --client claude

1. リポジトリをクローンし、プロジェクトディレクトリに移動します。
2. 依存関係をインストールします。

pip install -r requirements.txt

3. uv をインストールします。

curl -LsSf https://astral.sh/uv/install.sh | sh

💻 使用例

基本的な使用法

Cursor での使用例は以下の通りです。

{
    "mcpServers": {
        "cockroachdb-mcp": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/local/cockroachdb-mcp",
                "run",
                "server.py"
            ],
            "jdbc_url": "jdbc:postgresql://localhost:2626/your_database",
            "username": "your_username",
            "password": "your_password"
        }
    }
}

高度な使用法

MCP 関数の説明

ツール

• connect_database
  • 説明: CockroachDB データベースに接続します。
  • パラメータ:
    • jdbc_url: 接続するデータベースの JDBC URL です。
    • username: データベースにログインするユーザー名です。
    • password: データベースにログインするパスワードです。

リソース

• /tables

  • 説明: データベース内のすべてのテーブルを取得します。
  • メソッド: GET
  • レスポンス: すべてのテーブル名を含むリストを返します。

• /schema/{table}

  • 説明: 指定されたテーブルの構造情報を取得します。
  • メソッド: GET
  • パスパラメータ:
    • table: 構造情報を取得するテーブル名です。
  • レスポンス: 指定されたテーブルのフィールドとそのデータ型の情報を返します。

サンプルコード

curl http://localhost:2626/tables
# レスポンス: ["users", "products", "orders"]

curl http://localhost:2626/schema/users
# レスポンス: {
#   "columns": ["id", "name", "email", "created_at"],
#   "types": ["int", "text", "text", "timestamp"]
# }

📚 ドキュメント

ログ

位置

• ファイル: ./cockroachdb-mcp-server.log
• 内容: サーバーの起動、リクエスト、エラー情報が記録されます。

ログエントリの例

INFO: Server started on port 2626
DEBUG: Received request GET /tables
INFO: Response sent with status 200
ERROR: Error executing query: table 'nonexistent' not found

特殊文字の処理

• エスケープ: 特殊文字はバックスラッシュ \ でエスケープします。
• 例:

{
    "query": "SELECT * FROM `users` WHERE id = \\$1"
}

TCP アクティブ化設定

設定

uvicorn --reload --host 0.0.0.0 --port 2626 yourapp:app

パラメータ

• 自動再接続: データベース接続プールを使用して自動再接続を実現します。
• ハートビート検出: 定期的にクエリを実行して接続をアクティブに保ちます。

トラブルシューティング

一般的な問題

• Connection Refused
  • 原因: サーバーが起動していないか、バインドアドレスが間違っています。
  • 解決策: サーバーが指定されたポートで実行されていることを確認し、ファイアウォールがアクセスを許可していることを確認します。
• Query Timeout
  • 原因: クエリの実行時間が長すぎるか、データベースの負荷が高すぎます。
  • 解決策: クエリを最適化するか、データベースのリソースを増やします。
• Database Not Found
  • 原因: データベース名が間違っているか、正しく設定されていません。
  • 解決策: JDBC URL と資格情報が正しいことを確認します。

高度な設定

• 環境変数の使用

export DATABASE_URL="jdbc:postgresql://localhost:2626/your_database"
export DB_USER="your_username"
export DB_PASSWORD="your_password"

• 設定ファイルの例

from typing import List, Dict
import logging
from fastapi import FastAPI

app = FastAPI()

@app.get("/tables")
async def get_tables() -> List[str]:
    return ["users", "products", "orders"]

@app.get("/schema/{table}")
async def get_schema(table: str) -> Dict:
    schemas: Dict = {
        "users": {"columns": ["id", "name", "email"], "types": ["int", "text", "text"]},
        "products": {"columns": ["id", "name", "price"], "types": ["int", "text", "float"]}
    }
    return schemas.get(table, {"error": "Table not found"})

コントリビューション

問題の報告やプルリクエストは大歓迎です！ リポジトリのURL: https://github.com/yourusername/cockroachdb-mcp-server

📄 ライセンス

MIT License