Mysql MCP Servers

🚀 MySQL MCP サーバー

このプロジェクトは、Model Context Protocol (MCP) を使用して MySQL データベースとやり取りするサーバーを提供します。WSL 環境の MySQL データベースに対するインターフェースを提供します。

✨ 主な機能

• MySQL データベース内のテーブルリストを取得する
• テーブルからデータを読み取る（最大 100 行）
• SQL クエリを実行する（SELECT、SHOW TABLES、INSERT、UPDATE、DELETE などをサポート）

📚 ドキュメント

プロジェクト構造

src/mysql_mcp_server/
├── __init__.py        # パッケージ初期化ファイル
├── config/           # 設定関連モジュール
│   ├── __init__.py  
│   └── settings.py   # データベース設定
├── database/         # データベース操作モジュール
│   ├── __init__.py  
│   ├── connection.py # データベース接続処理
│   └── errors.py     # エラークラス
├── tools/            # ツールモジュール
│   ├── __init__.py  
│   └── sql_tools.py  # SQL 実行ツール
└── server.py         # MCP サーバーメインファイル

インストールと実行

前提条件

• Python 3.11 以上
• MySQL サーバー（ローカルまたはリモート）
• 仮想環境（virtualenv）
• Docker（Docker を使用する場合）

セットアップ

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

   git clone <repository-url>
   cd mysql_mcp_server
   

2. 仮想環境を作成してアクティブ化する：

   python -m venv .venv
   source .venv/bin/activate  # Linux システム
   

3. 依存関係をインストールする：

   pip install -r requirements.txt .
   

4. 実行権限を付与して設定スクリプトを実行する：

   chmod +x setup.sh
   ./setup.sh
   

実行方法

サーバーは以下のいずれかの方法で実行できます。

1. 直接実行

./run_direct.sh

2. モジュールとして実行

./run_module.sh

3. Docker コンテナで実行

# Docker イメージをビルドする
docker build -t mysql-mcp-server:latest .

# コンテナを実行する
./run_docker.sh

環境変数

サーバーは以下の環境変数を使用して MySQL に接続します。

MCP プロトコル

このサーバーは MCP プロトコルを実装し、以下のエンドポイントを提供します。

• list_resources: データベース内のテーブルリストを取得する
• read_resource: 特定のテーブルからデータを読み取る
• list_tools: 利用可能なツールをリストする
• execute_query: SQL クエリを実行する

WSL 環境の注意事項

WSL 環境で実行する場合は、ファイルパスとネットワーク設定に注意してください。詳細はドキュメントの WSL セクションを参照してください。

テスト

Nox を使用してテストを実行する

1. Nox をインストールする：

   pip install nox
   

2. すべてのテストを実行する：

   nox -s test
   

3. コードをフォーマットする：

   nox -s format
   

4. コードチェックを実行する：

   nox -s lint
   

テストを直接実行する

pytest tests/

コードカバレッジを確認する

pytest --cov=src.mysql_mcp_server tests/

📄 ライセンス

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