Mysql Query MCP Server

🚀 MySQL 查询 MCP 服务器

MySQL Query MCP サーバーは、MCP プロトコルに準拠したプロジェクトです。AI アシスタントを通じて MySQL データベースとのインタラクションを可能にします。このツールは、読み取り専用の SQL クエリの実行、データベース情報の取得、および設定された環境の一覧表示をサポートしています。

🚀 クイックスタート

MySQL Query MCP サーバーを使用することで、AI アシスタントと MySQL データベースを簡単に連携できます。以下の手順でサーバーを起動し、データベース操作を始めましょう。

✨ 主な機能

• AI アシスタントを介した MySQL データベースとのインタラクションをサポート。
• 読み取り専用の SQL クエリの実行が可能。
• データベース情報の取得と設定環境の一覧表示ができる。

📦 インストール

快速安装

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

git clone git@github.com:devakone/mysql-query-mcp-server.git
cd mysql-query-mcp-server

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

npm install

3. サーバーを起動します：

node index.js

詳細なインストール手順

前提条件

• Node.js (バージョン 16.x 以上)
• npm (バージョン 5.x 以上)

依存関係のインストール

以下のコマンドを実行して、プロジェクトに必要なすべての依存関係をインストールします：

npm install

サーバーの起動

MySQL Query MCP サーバーを起動します：

node index.js

📚 ドキュメント

設定ガイド

設定ファイルの作成

プロジェクトのルートディレクトリに config.json ファイルを作成し、以下の内容を追加します：

{
  "environments": {
    "local": {
      "host": "localhost",
      "port": 3306,
      "user": "root",
      "password": "password"
    },
    "development": {
      "host": "127.0.0.1",
      "port": 3306,
      "user": "dev",
      "password": "devpass"
    },
    "staging": {
      "host": "mysql-staging.example.com",
      "port": 3306,
      "user": "staging",
      "password": "stagepass"
    },
    "production": {
      "host": "mysql-production.example.com",
      "port": 3306,
      "user": "prod",
      "password": "prodpass"
    }
  }
}

設定オプション

• environments: 異なるデータベース環境を定義します。
• 各環境には以下の属性が含まれます：
  • host: データベースのホストアドレス。
  • port: データベースのポート。
  • user: 接続するユーザー名。
  • password: ユーザーのパスワード。

使用ガイド

環境変数

プロジェクトのルートディレクトリに .env ファイルを作成し、以下の内容を追加します：

DEBUG=true

true に設定すると、デバッグモードが有効になり、より多くのログ情報が出力されます。

コマンドラインツール

ツールの概要

MySQL Query MCP サーバーは、3 つの主要なコマンドラインツールを提供します：

1. query

読み取り専用の SQL クエリを実行します：

-- サンプルクエリ：query ツールを使用して以下のクエリを実行
SELECT * FROM customers WHERE signup_date > '2023-01-01' LIMIT 10;

サポートされるクエリタイプ（厳密に制限）：

• SELECT 文
• SHOW コマンド
• DESCRIBE/DESC テーブル

2. info

データベースの詳細情報を取得します：

• サーバーバージョン
• 接続状態
• データベース変数
• プロセスリスト
• 利用可能なデータベース

3. environments

設定されたすべての環境を一覧表示します：

environments ツールを使用して、利用可能なデータベース環境を表示します。

セキュリティに関する注意事項

• ✅ 読み取り専用のクエリ（SELECT、SHOW、DESCRIBE）のみを許可します。
• ✅ 各環境には独自の分離された接続プールがあります。
• ✅ 本番環境での SSL 接続をサポートします。
• ✅ クエリのタイムアウト機能があり、長時間実行される操作を防止します。
• ⚠️ データベースを保護するために、専用ネットワークと認証の使用を検討してください。

プロジェクトへの貢献

貢献を歓迎します！ 何か問題や提案があれば、Issues で投稿してください。

開発ガイド

テストの実行方法

1. 依存関係をインストールします：

npm install

2. テストを実行します：

npm test

新機能の追加方法

1. config.json で新しい環境を定義します。
2. 新しいデータベースタイプや機能をサポートするようにコードを変更します。

📄 ライセンス

このプロジェクトは MIT ライセンス に準拠しています。