Dpflucas Mysql MCP Server

🚀 MySQL データベースアクセス MCP サーバー

この MCP サーバーは、MySQL データベースへの読み取り専用アクセスを提供します。以下の操作が可能です：

• 利用可能なデータベースを一覧表示する
• 指定したデータベース内のテーブルを一覧表示する
• テーブルのスキーマを説明する
• 読み取り専用の SQL クエリを実行する

✨ 主な機能

• 読み取り専用アクセス：SELECT、SHOW、DESCRIBE、EXPLAIN ステートメントのみを許可します。
• クエリ検証：SQL インジェクションを防止し、データの変更試行をブロックします。
• クエリタイムアウト：長時間実行されるクエリがリソースを消費するのを防止します。
• 行制限：過剰なデータの返却を防止します。

📦 インストール

方法1：NPM を通じてインストール（推奨）

# グローバルインストール
npm install -g mysql-mcp-server

# または、プロジェクト内にローカルインストール
npm install mysql-mcp-server

方法2：ソースコードからビルド

# リポジトリをクローン
git clone https://github.com/dpflucas/mysql-mcp-server.git
cd mysql-mcp-server

# 依存関係をインストールしてビルド
npm install
npm run build

3. 環境変数の設定

サーバーには以下の環境変数が必要です：

• MYSQL_HOST：データベースサーバーのホスト名
• MYSQL_PORT：データベースサーバーのポート（デフォルト：3306）
• MYSQL_USER：データベースのユーザー名
• MYSQL_PASSWORD：データベースのパスワード
• MYSQL_DATABASE：デフォルトのデータベース名（オプション）

4. MCP 設定に追加

MCP 設定ファイルに以下の設定を追加します。

NPM を通じてインストールした場合（方法1）：

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["mysql-mcp-server"],
      "env": {
        "MYSQL_HOST": "${MYSQL_HOST}",
        "MYSQL_PORT": "${MYSQL_PORT}",
        "MYSQL_USER": "${MYSQL_USER}",
        "MYSQL_PASSWORD": "${MYSQL_PASSWORD}",
        "MYSQL_DATABASE": "${MYSQL_DATABASE}"
      }
    }
  }
}

ソースコードからビルドした場合（方法2）：

{
  "mcpServers": {
    "mysql": {
      "command": "node",
      "args": ["dist/index.js"],
      "env": {
        "MYSQL_HOST": "${MYSQL_HOST}",
        "MYSQL_PORT": "${MYSQL_PORT}",
        "MYSQL_USER": "${MYSQL_USER}",
        "MYSQL_PASSWORD": "${MYSQL_PASSWORD}",
        "MYSQL_DATABASE": "${MYSQL_DATABASE}"
      }
    }
  }
}

💻 使用例

mysql-cli

• 機能：コマンドラインインターフェースを通じてデータベースをクエリする。
• パラメータ：
  • --host または -H：MySQL ホストを指定します。デフォルトは localhost です。
  • --port または -P：MySQL ポートを指定します。デフォルトは 3306 です。
  • --user または -u：MySQL ユーザー名を指定します。
  • --password または -p：MySQL パスワードを指定します。
  • --database または -D：デフォルトのデータベース名を指定します。

mysql-rest

• 機能：REST API を通じてデータベースをクエリする。
• 設定パラメータ：
  • port：サーバーがリッスンするポートを指定します。デフォルトは 3000 です。
  • host：MySQL ホストを指定します。デフォルトは localhost です。
  • user：MySQL ユーザー名を指定します。
  • password：MySQL パスワードを指定します。
  • database：デフォルトのデータベース名を指定します。

mysql-dump

• 機能：データベースのテーブル構造とデータをエクスポートする。
• 使用例：

# すべてのテーブル構造をエクスポート
./mysql-dump.sh --host=localhost --port=3306 --user=root --password=admin

# 特定のデータベースのデータをエクスポート
./mysql-dump.sh --database=mydb > mydb_dump.sql

📚 ドキュメント

テストガイド

準備

1. テスト用データベース mcp_test_db を作成し、テストユーザーに適切な権限を付与します。
2. すべての環境変数が正しく設定されていることを確認します。

テストの実行

単体テスト

以下のコマンドを実行して単体テストを実行します：

npm test

ツールテスト

以下のコマンドを実行してツールの機能をテストします：

npm run test:tools

トラブルシューティング

問題が発生した場合：

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

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細については LICENSE ファイルを参照してください。