Mysql Database Explorer

🚀 MySQL MCP サーバードキュメント

このドキュメントは、MySQL データベースの接続と管理に使用される MCP（MySQL Connection Pool）サーバーに関するものです。このサーバーは、読み取り専用アクセス、コネクションプールの設定、高度なテストツールなど、様々な機能をサポートしています。

🚀 クイックスタート

このセクションでは、MySQL MCP サーバーの基本的なセットアップと使用方法を説明します。

✨ 主な機能

• 読み取り専用アクセスをサポート
• コネクションプールの設定が可能
• 高度なテストツールを提供

📦 インストール

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

以下のコマンドを使用して、パッケージをインストールできます。

npm install mysql-mcp-server

ソースコードからのビルド

1. リポジトリをクローンします。

git clone https://github.com/username/mysql-mcp-server.git
cd mysql-mcp-server

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

npm install

📚 ドキュメント

環境変数の設定

config.json ファイルに以下の環境変数を設定します。

{
  "MYSQL_HOST": "localhost",    // MySQL サーバーのアドレス
  "MYSQL_PORT": 3306,          // MySQL のポート番号
  "MYSQL_USER": "root",        // ユーザー名
  "MYSQL_PASSWORD": "password"  // パスワード
}

MCP の設定例

mcp-config.json ファイルに以下の設定を追加します。

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["mysql-mcp-server"],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "root",
        "MYSQL_PASSWORD": "password",
        "MYSQL_DATABASE": "testDB"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

利用可能なツール

データベースの一覧表示

{
  "server_name": "mysql",
  "tool_name": "list_databases",
  "arguments": {}
}

テーブルの一覧表示

{
  "server_name": "mysql",
  "tool_name": "list_tables",
  "arguments": {
    "database": "testDB"
  }
}

テーブルの説明表示

{
  "server_name": "mysql",
  "tool_name": "describe_table",
  "arguments": {
    "database": "testDB",
    "table": "users"
  }
}

クエリの実行

{
  "server_name": "mysql",
  "tool_name": "execute_query",
  "arguments": {
    "database": "testDB",
    "query": "SELECT * FROM users LIMIT 10"
  }
}

高度なコネクションプールの設定

config.json に以下の高度なパラメータを追加します。

{
  "MYSQL_CONNECTION_LIMIT": 10,       // コネクションプールの最大容量（デフォルトは 10）
  "MYSQL_QUEUE_LIMIT": 0,             // 待機キューの最大数（デフォルトは 0、無制限）
  "MYSQL_CONNECT_TIMEOUT": 10000,      // 接続タイムアウト時間（ミリ秒、デフォルトは 10 秒）
  "MYSQL_IDLE_TIMEOUT": 60000,        // アイドル接続のタイムアウト時間（ミリ秒、デフォルトは 60 秒）
  "MYSQL_MAX_IDLE": 10               // 最大アイドル接続数（デフォルトは 10）
}

テスト手順

テスト用データベースの設定

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password

npm run test:setup

MCP ツールのテスト

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password
export MYSQL_DATABASE=testDB

npm run test:tools

すべてのテストの実行

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password

npm test

トラブルシューティング

1. サーバーのログを確認して、エラーメッセージを確認します。
2. MySQL の認証情報と接続設定が正しいことを確認します。
3. MySQL ユーザーが適切な権限を持っていることを確認します。
4. クエリが読み取り専用で、正しい形式であることを確認します。

📄 ライセンス

このソフトウェアは MIT ライセンスの下で提供されています。詳細なライセンス情報については、LICENSE ファイルを参照してください。