Mangooer Mysql MCP Server Sse

🚀 MySQLクエリサーバー

このサーバーはMCP（モデル - コントローラー - プロバイダー）フレームワークに基づいて構築されたMySQLクエリサーバーで、SSE（Server-Sent Events）を通じたMySQLデータベース操作機能を提供します。

✨ 主な機能

• FastMCPフレームワークに基づいて構築
• SSE（Server-Sent Events）によるリアルタイムデータ転送をサポート
• MySQLデータベースクエリインターフェースを提供
• 完全なログ記録システム
• 自動トランザクション管理（コミット/ロールバック）
• 環境変数による設定をサポート
• SQLセキュリティチェック機構
  • リスクレベルの制御
  • SQLインジェクション対策
  • 危険な操作のブロック
  • WHERE句の強制チェック
  • 自動的に更新操作の影響行数を返す

📦 インストール

システム要件

• Python 3.6以上
• MySQLデータベース

インストール手順

1. Python（バージョン3.6以上）をダウンロードしてインストールします。
2. 必要な依存関係をインストールします：

   pip install -r requirements.txt
   

3. データベース接続情報を設定するため、config.iniファイルを編集します。
4. サーバーを起動します：

   python server.py
   

📚 ドキュメント

環境変数の設定

サーバーは環境変数を通じて設定されます。以下は一般的な環境変数とその機能です：

SQLセキュリティ機構

サーバーには強力なSQLセキュリティ機構が組み込まれており、データクエリの安全性を確保します：

1. リスクレベルの制御：各SQL操作のリスクレベルはシステムによって自動的に評価され、ALLOWED_RISK_LEVELS環境変数に基づいて実行の許可が決定されます。
2. SQLインジェクション対策：ORM（オブジェクトリレーショナルマッピング）フレームワークとパラメータ化クエリを使用して、SQLインジェクション攻撃を防止します。
3. 危険な操作のブロック：データ損失の可能性のある高リスク操作（TRUNCATE、DELETEなど）はブロックされ、手動で承認する必要があります。
4. WHERE句の強制チェック：すべてのクエリには有効なWHERE句が含まれている必要があり、クエリの対象を明確にします。

サーバーの起動

1. 環境変数が正しく設定されていることを確認します：

   export MYSQL_HOST=localhost MYSQL_PORT=3306 MYSQL_USER=root MYSQL_PASSWORD=root MYSQL_DB=testdb
   

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

   python server.py
   

プロジェクト構造

mysql_query_server/
├── server.py                  # メインプログラムのエントリーポイント
├── config.ini                # データベース設定ファイル
├── requirements.txt          # 依存関係管理
└── README.md                 # プロジェクト説明ドキュメント

よくある問題の解決策

1. 環境変数が機能しない場合

• server.pyでload_dotenv()関数が他のモジュールのインポートより前に呼び出されていることを確認します。
• アプリケーションを再起動して、環境変数が正しく読み込まれるようにします。

2. 操作がセキュリティ機構によって拒否された場合

• 操作のリスクレベルが許容範囲を超えていないか確認します。
• 高リスク操作を実行する必要がある場合は、ALLOWED_RISK_LEVELS設定を調整します。

3. WHERE条件なしの更新または削除操作

• 操作のリスクを下げるため、有効なWHERE句を追加します。

ログシステム

サーバーには完全なログ記録システムが統合されており、コンソール出力とファイル記録をサポートしています。ログレベルはserver.pyの設定を変更することで調整できます。

エラー処理

サーバーには完全なエラー処理機構が備わっています：

• データベース接続のチェック
• 設定の検証
• SQLセキュリティチェック
• 実行時エラーの捕捉と記録
• 自動トランザクションロールバック

貢献ガイド

IssueとPull Requestの提出を通じて、プロジェクトの改善に参加することを歓迎します。

📄 ライセンス

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

誰でもこのソフトウェアのコピーを無料で使用、複製、修正、統合、公開、販売することができますが、以下の著作権表示を含める必要があります。

著作権表示

Copyright (c) 2024 MCP MySQL Query Server

一切の保証を伴わないものとします。このソフトウェアの使用またはその他の事項に起因する請求、損害、またはその他の責任について、作者または著作権者は一切の責任を負いません。

このソフトウェアは「現状のまま」提供され、明示または暗示を問わず、いかなる保証も伴いません。