DB Connector (MySQL/PostgreSQL)

🚀 DB MCP Server

DB MCP Serverをスムーズに使用するために、以下のガイドを参考にしてください。このサーバーは、データベース関連の操作を効率的に行うためのサービスを提供します。

🚀 クイックスタート

DB MCP Serverをすぐに起動して実行するには、以下の手順に従ってください。

1. ソースコードのダウンロード：

   git clone https://github.com/FreePeak/db-mcp-server.git
   cd db-mcp-server
   

2. 依存関係のインストール： プロジェクトのルートディレクトリで、次のコマンドを実行します。

   go mod tidy
   

3. バイナリファイルのビルド： 以下のコマンドを実行して、実行可能ファイルをコンパイルします。

   go build -o bin/server .
   

4. サービスの実行： サーバーを起動します。

   ./bin/server --config=config.json
   

5. ドキュメントの参照： docs/ディレクトリ内の詳細な使用説明を確認してください。

📦 インストール

依存ツールのインストール

以下のツールがインストールされていることを確認してください。

• Go言語環境（推奨バージョン1.20以上）
• Git（リポジトリのクローンに使用）

リポジトリのクローン

ターミナルで次のコマンドを実行します。

git clone https://github.com/FreePeak/db-mcp-server.git
cd db-mcp-server

依存関係のインストール

以下のコマンドを実行して、プロジェクトに必要なGoパッケージをインストールします。

go mod tidy

実行可能ファイルのビルド

サーバーのバイナリファイルをビルドします。

go build -o bin/server .

サービスの設定

config.json設定ファイルを作成し、以下のサンプル内容を参考にしてください。

{
    "port": 9095,
    "mode": "sae", // 選択可能な値: sae、http
    "connections": [
        {
            "id": "mysql1",
            "type": "mysql",
            "host": "localhost",
            "port": 3306,
            "user": "root",
            "password": "password",
            "name": "testdb"
        }
    ]
}

サービスの起動

以下のコマンドを実行して、サーバーを起動します。

./bin/server --config=config.json

💻 使用例

基本的な使用法

• SSEモード：ブラウザや他のクライアントで、次のように接続できます。

const eventSource = new EventSource('http://localhost:9095/sse');
eventSource.onmessage = (event) => {
    console.log('Received:', event.data);
};

• HTTPモード：REST APIを介してやり取りし、JSONリクエストとレスポンスをサポートします。

高度な使用法

設定ファイルの説明

config.jsonには主に以下の設定項目が含まれています。

サンプル使用シナリオ

• データのクエリ：

{
    "tool": "query_mysql",
    "params": {
        "query": "SELECT * FROM users LIMIT 10"
    }
}

• トランザクションの実行：

{
    "tool": "transaction_mysql",
    "params": {
        "operations": [
            { "query": "UPDATE orders SET status = 'paid'" },
            { "query": "INSERT INTO log (action) VALUES ('order paid')" }
        ]
    }
}

📚 ドキュメント

よくある問題とトラブルシューティング

1. サービスの起動に失敗しました

• 原因：設定ファイルのエラーまたはデータベースへの接続ができません。
• 解決策：
  • config.json内のデータベースパラメータが正しいことを確認してください。
  • データベースサービスが実行されており、ネットワークにアクセス可能であることを確認してください。

2. SSEモードで接続できません

• 原因：ファイアウォールがSSE通信をブロックしているか、ブラウザがEventSource APIをサポートしていません。
• 解決策：
  • ターゲットポートが開いていることを確認し、ネットワークの接続性をチェックしてください。
  • 最新バージョンのモダンブラウザを使用してサービスにアクセスしてください。

3. パフォーマンスの問題

• 原因：接続プールの設定が不適切またはクエリの効率が低い。
• 解決策：
  • データベースのパフォーマンスに合わせて接続プールのパラメータ（max_open_connsやmax_idle_connsなど）を調整してください。
  • SQLクエリを最適化し、全表スキャンを避けてください。

4. ログとデバッグ

• ログ出力：デフォルトでは、サービスは標準ログをコンソールに出力します。ファイルログを有効にするには、ドキュメントを参照して設定してください。
• エラーのトラブルシューティング：サーバーポートが使用中でないことを確認し、具体的なエラーメッセージを確認して問題を解決してください。

その他のリソース

• 公式ドキュメント
• コミュニティディスカッション
• ソースコードリポジトリ

問題が発生した場合や改善提案がある場合は、いつでもGitHubでissueを提出してください。