Skip to main content
Glama

MySQL MCP Server

by yuki777

MySQL MCP Server

MySQL Model Context Protocol(MCP)サーバーは、ローカル環境のMySQLデータベースに接続し、大規模言語モデル(LLM)がSQLクエリを実行できるようにするツールです。

要件

  • Node.js: 20.0.0以上
  • MySQL: 5.7以上のMySQLまたはMariaDBサーバー

機能

  • MySQLクエリの実行: LLMからSQLクエリを直接実行
  • データベース情報の取得: データベース一覧、テーブル一覧、テーブル構造の確認
  • MCP準拠: Model Context Protocol に対応し、LLMと統合可能
  • stdio通信: 標準入出力を使用してLLMと通信、ポートバインドなし
  • 接続プロファイル管理: 複数の接続設定をプロファイル名で管理し切り替え
  • 接続情報の保存: データベース接続情報をローカルに保存し再利用

インストールと使用方法

NPXでの一時実行

npx -y https://github.com/yuki777/mysql-mcp-server --host 127.0.0.1 --port 13306 --user root

オプション

オプション説明デフォルト値
-h, --host <host>MySQLホストlocalhost
-p, --port <port>MySQLポート13306
-u, --user <user>MySQLユーザーroot
--password <password>MySQLパスワード(空文字)
-d, --database <database>デフォルトデータベース(オプション)
-c, --config <path>設定ファイルパス(オプション)
--auto-connectサーバー起動時に自動的にデータベースに接続false
--server-port <port>MCPサーバーポート(stdioモードでは使用されません)3000
--server-host <host>MCPサーバーホスト(stdioモードでは使用されません)localhost
--query-timeout <ms>クエリタイムアウト(ミリ秒)30000
--max-results <count>最大結果行数1000
--debugデバッグモードfalse

接続情報の保存と再利用

MySQL MCP Serverは、正常に接続したデータベースの情報を名前付きプロファイルとしてローカルに保存します。これにより、次回の起動時に接続情報を名前で指定して再利用できます。保存された接続情報は、ユーザーのホームディレクトリにある .mysql-mcp-connections.json ファイルに保存されます。

各接続プロファイルには以下が含まれます:

  • プロファイル名
  • ホスト名
  • ポート番号
  • ユーザー名
  • パスワード
  • データベース名(設定されている場合)

複数のデータベース接続をプロファイル名で管理し、簡単に切り替えることが可能です。

設定ファイルの使用

設定ファイル(JSON形式)を使用して接続情報を設定することもできます:

{ "server": { "port": 3000, "host": "localhost" }, "mysql": { "host": "localhost", "port": 13306, "user": "root", "password": "yourpassword", "database": "mydb" }, "debug": false, "queryTimeout": 30000, "maxResultSize": 1000 }

設定ファイルを使用する場合:

npx -y https://github.com/yuki777/mysql-mcp-server -c ./mysql-mcp-config.json

通信方式

MySQL MCP ServerはMCP (Model Context Protocol) に準拠した「stdio」モードで動作します。これにより特定のポートにバインドせず、標準入出力を介して通信します。これには次のような利点があります:

  1. ポート競合の回避: 特定のポートを使用しないため、ポート競合の問題が発生しません
  2. セキュリティ向上: ネットワーク通信を使用しないため、ネットワークレベルの攻撃リスクが軽減
  3. 簡素なプロセス間通信: LLMとの通信がシンプル化

注意点

  • stdioモードでは、JSON形式のメッセージをやり取りします
  • 一行に一つのJSONメッセージを送信する必要があります
  • エラー情報と接続ログは標準エラー(stderr)に出力されます

提供されるMCPツール

データベース接続管理

ツール名説明必須パラメータ
connect_databaseデータベースに接続しますhost, port, user
connect_by_profile保存済みプロファイル名で接続しますprofileName
disconnect_database現在のデータベース接続を切断しますなし
get_connection_statusデータベース接続の状態を取得しますなし

接続プロファイル管理

ツール名説明必須パラメータ
list_profiles保存済みのプロファイル一覧を取得しますなし
get_profileプロファイルの詳細を取得しますprofileName
add_profile新しいプロファイルを追加しますprofileName, host, port, user
remove_profileプロファイルを削除しますprofileName

SQLクエリ操作

ツール名説明必須パラメータ
execute_queryMySQLクエリを実行しますquery: SQL文
get_databases利用可能なデータベースの一覧を取得しますなし
get_tables指定したデータベース内のテーブル一覧を取得しますdatabase (オプション)
describe_table指定したテーブルの構造を取得しますtable

接続管理機能

MySQL MCP Serverでは、サーバーの起動とデータベース接続を分離することができます。このアプローチにより以下のメリットがあります:

  1. 接続情報なしでの起動: サーバーはデータベース接続情報がなくても起動可能
  2. 複数データベースへの接続: サーバー起動後に異なるデータベースへ接続の切り替えが可能
  3. シンプルなインストール: npx -y https://github.com/yuki777/mysql-mcp-server だけで実行可能

接続管理の使用方法

  1. 自動接続なしでサーバーを起動:
    npx -y https://github.com/yuki777/mysql-mcp-server
  2. 接続ツールを使用してデータベースに接続(プロファイル名を指定して保存):
    { "type": "tool_call", "request_id": "req_1", "tool": "connect_database", "arguments": { "host": "localhost", "port": 3306, "user": "root", "password": "your_password", "database": "your_db", "profileName": "my-db" } }
  3. プロファイル一覧の取得:
    { "type": "tool_call", "request_id": "req_2", "tool": "list_profiles", "arguments": {} }
  4. プロファイル名で接続:
    { "type": "tool_call", "request_id": "req_3", "tool": "connect_by_profile", "arguments": { "profileName": "my-db" } }
  5. 新しいプロファイルの追加(接続は行わない):
    { "type": "tool_call", "request_id": "req_4", "tool": "add_profile", "arguments": { "profileName": "production-db", "host": "prod.example.com", "port": 3306, "user": "prod_user", "password": "prod_password", "database": "production" } }
  6. 接続状態の確認:
    { "type": "tool_call", "request_id": "req_5", "tool": "get_connection_status", "arguments": {} }
  7. 接続の切断:
    { "type": "tool_call", "request_id": "req_6", "tool": "disconnect_database", "arguments": {} }

テスト用スクリプト

リポジトリには test-connection-management.js というテストスクリプトが含まれています。このスクリプトを使用して、接続管理機能をテストできます:

node test-connection-management.js

開発者向け情報

開発環境のセットアップ

# リポジトリのクローン git clone [repository-url] cd mysql-mcp-server # 依存関係のインストール npm install # 開発モードでの実行 npm run dev

ビルド

npm run build

ライセンス

ISC

貢献

バグレポートや機能リクエスト、プルリクエストを歓迎します。

-
security - not tested
F
license - not found
-
quality - not tested

local-only server

The server can only run on the client's local machine because it depends on local resources.

A tool that connects to local MySQL databases and enables large language models (LLMs) to execute SQL queries through the Model Context Protocol (MCP).

  1. 要件
    1. 機能
      1. インストールと使用方法
        1. NPXでの一時実行
        2. オプション
        3. 接続情報の保存と再利用
        4. 設定ファイルの使用
      2. 通信方式
        1. 注意点
      3. 提供されるMCPツール
        1. データベース接続管理
        2. 接続プロファイル管理
        3. SQLクエリ操作
      4. 接続管理機能
        1. 接続管理の使用方法
        2. テスト用スクリプト
      5. 開発者向け情報
        1. 開発環境のセットアップ
        2. ビルド
      6. ライセンス
        1. 貢献

          Related MCP Servers

          • -
            security
            A
            license
            -
            quality
            A Model Context Protocol server that provides read-only access to MySQL databases, enabling LLMs to inspect database schemas and execute read-only queries.
            Last updated -
            5,426
            418
            TypeScript
            MIT License
            • Linux
            • Apple
          • -
            security
            A
            license
            -
            quality
            A Model Context Protocol server providing read-only access to MySQL databases, enabling LLMs to inspect database schemas and execute read-only queries.
            Last updated -
            5,426
            TypeScript
            MIT License
            • Linux
            • Apple
          • -
            security
            A
            license
            -
            quality
            A Model Context Protocol server that provides read-only access to MySQL databases, enabling LLMs to inspect database schemas and execute read-only queries.
            Last updated -
            5,426
            MIT License
          • -
            security
            A
            license
            -
            quality
            A Model Context Protocol (MCP) server that enables AI assistants to interact with MySQL databases by executing SQL queries and checking database connectivity.
            Last updated -
            TypeScript
            MIT License
            • Apple
            • Linux

          View all related MCP servers

          MCP directory API

          We provide all the information about MCP servers via our MCP API.

          curl -X GET 'https://glama.ai/api/mcp/v1/servers/yuki777/mysql-mcp-server'

          If you have feedback or need assistance with the MCP directory API, please join our Discord server