Go MCP Mysql

🚀 零负担、即用型モデルコンテキストプロトコル（MCP）MySQLサーバー

このサーバーは、MySQLとのインタラクションと自動化を目的とした零負荷、即用型のモデルコンテキストプロトコル（MCP）サーバーです。Node.jsやPython環境を必要とせず、MySQLデータベースとテーブルに対するCRUD操作を行うためのツールを提供します。また、誤った書き込み操作を防ぐための読み取り専用モードも用意されています。--with-explain-checkフラグを追加することで、クエリを実行する前にEXPLAIN文を使用してクエリプランをチェックする機能を有効にすることもできます。

なお、このプロジェクトは開発中であり、本番環境での使用にはまだ準備ができていない可能性があります。

🚀 クイックスタート

📦 インストール

1. 最新のリリースバージョンをダウンロードし、$PATHに配置するか、簡単にアクセスできる場所に置きます。
2. または、Goがインストールされている場合は、ソースコードからビルドすることができます。

go install -v github.com/Zhwt/go-mcp-mysql@latest

💻 使用例

基本的な使用法

方法A：コマンドライン引数を使用する

{
  "mcpServers": {
    "mysql": {
      "command": "go-mcp-mysql",
      "args": [
        "--host", "localhost",
        "--user", "root",
        "--pass", "password",
        "--port", "3306",
        "--db", "mydb"
      ]
    }
  }
}

方法B：カスタムオプション付きのDSNを使用する

{
  "mcpServers": {
    "mysql": {
      "command": "go-mcp-mysql",
      "args": [
        "--dsn", "username:password@tcp(localhost:3306)/mydb?parseTime=true&loc=Local"
      ]
    }
  }
}

詳細については、MySQL DSNを参照してください。

⚠️ 重要提示

バイナリファイルを$PATHに含まれない場所に配置した場合は、go-mcp-mysqlを完全パスで置き換える必要があります。例えば、バイナリファイルをダウンロードフォルダに配置した場合は、以下のようなパスを使用できます。

{
  "mcpServers": {
    "mysql": {
      "command": "C:\\Users\\<username>\\Downloads\\go-mcp-mysql.exe",
      "args": [
        ...
      ]
    }
  }
}

高度な使用法

オプションフラグ

• --read-onlyフラグを追加すると、読み取り専用モードが有効になります。このモードでは、list、read_、desc_で始まるツールのみ使用できます。このフラグを追加した後は、必ずリフレッシュ/再起動してください。
• クエリを実行する前にEXPLAIN文を使用してクエリプランをチェックする機能を有効にするには、以下のようにします。

# 単一クエリのチェック
go-mcp-mysql --dsn "root:password@tcp(localhost:3306)/test" --with-explain -sql "SELECT * FROM user"

# すべてのクエリのチェックを有効にする
export GMCP_CHECK_QUERY=true

ツール

Schema Tools

mysql-backup

• 機能：指定されたデータベースのすべてのテーブル構造をバックアップします。
• パラメータ：
  • --src-dsn：ソースデータベースの接続文字列（必須）。
  • --dest-filename：出力ファイル名。{db}_{table}.sql形式（オプション、デフォルトはstdout）。
• 例：

mysql-backup --src-dsn "root:password@tcp(localhost:3306)/test"

Data Tools

mysql-import

• 機能：SQLファイルを指定されたデータベースにインポートします。
• パラメータ：
  • --dsn：データベースの接続文字列（必須）。
  • --filename：入力ファイルのパス（必須）。
• 例：

mysql-import --dsn "root:password@tcp(localhost:3306)/test" --filename user.sql

mysql-export

• 機能：指定されたデータベースのすべてのテーブルをSQLファイルとしてエクスポートします。
• パラメータ：
  • --src-dsn：ソースデータベースの接続文字列（必須）。
  • --dest-filename：出力ファイル名。{db}_{table}.sql形式（オプション、デフォルトはstdout）。
• 例：

mysql-export --src-dsn "root:password@tcp(localhost:3306)/test"

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。