Mysql Server 5ac

🚀 MySQL テンプレートボイラープレートプロジェクト

このプロジェクトは、MySQLを使用したアプリケーションの開発を支援するテンプレートボイラープレートです。構造的に明確で、拡張性と保守性に優れており、安全なデプロイと実行が可能です。

🚀 クイックスタート

ローカルでの実行

# 環境の設定
cp .env.example .env

# .env ファイルを必要に応じて変更する

# 依存関係のインストール
pip install -r requirements.txt

# サーバーの起動
python mysql_mcp_server/main.py run

✨ 主な機能

• 明確なディレクトリ構造により、開発と保守が容易です。
• 拡張性が高く、新しいツールを簡単に追加できます。
• 安全なデプロイと実行のための考慮事項が盛り込まれています。

📦 インストール

Dockerを使用した実行

# イメージのビルド
docker build -t mysql-mcp .

# コンテナの起動
docker run --name mysql-mcp-container -p 5000:5000 mysql-mcp

📚 ドキュメント

ディレクトリ構造

以下はプロジェクトのディレクトリ構造です。

MCPBoilerPlate/
├── mysql_mcp_server/           # メインアプリケーションディレクトリ
│   ├── executors/              # データベース操作実行器
│   │   ├── create_table.py     # テーブル作成ツール
│   │   ├── desc_table.py       # テーブル構造確認ツール
│   │   ├── explain.py          # クエリ実行計画提供ツール
│   │   ├── insert_query.py     # INSERTクエリ実行ツール
│   │   ├── insight_starter.py  # レポート作成用のアーキテクチャ検証ツール
│   │   ├── invoke_viz_pro.py   # 可視化グラフ推奨ツール
│   │   ├── select_query.py     # SELECTクエリ実行ツール
│   │   └── show_tables.py      # テーブルリスト取得ツール
│   ├── helper/                 # ツールモジュール
│   │   ├── db_conn_helper.py   # データベース接続管理
│   │   ├── logger_helper.py    # ログユーティリティ
│   │   └── tool_decorator.py   # ツールデコレータ
│   └── main.py                 # アプリケーションエントリポイント
├── docker-compose.yml          # Docker Compose設定
├── Dockerfile                  # Dockerイメージ構築設定
├── requirements.txt            # 依存関係パッケージリスト
└── .env.example                # サンプル環境変数ファイル

アーキテクチャ設計

階層構造

1. インターフェース層: MCPサーバー (FastMCP)
2. ビジネスロジック層: プロセッサと実行器
3. データアクセス層: データベース接続とクエリ実行

主要なクラスとモジュール

• MySQLMCPServer: メインサーバークラスで、MCPサーバーの初期化と実行を担当します。
• DatabaseManager: シングルトンパターンのデータベース接続マネージャー
• 実行器: データベース操作の集合ツール
  • execute_create_table: テーブルの作成
  • execute_desc_table: テーブル構造の確認
  • execute_explain: クエリ実行計画の提供
  • execute_insert_query: INSERTクエリの実行
  • execute_select_query: SELECTクエリの実行
  • execute_show_tables: テーブルリストの取得

通信フロー

1. AIモデルがMCPサーバーに利用可能なツールのリストを要求します。
2. サーバーが利用可能なツールリストを返します。
3. AIモデルが特定のツールの実行を要求します。
4. サーバーが該当する実行器を呼び出してデータベース操作を行います。
5. 実行結果がAIモデルに返されます。

拡張性と保守性

ツールの追加

executors ディレクトリに新しいツールを実装し、__init__.py で登録します。

環境変数の管理

環境変数を使用して資格情報と設定を管理し、機密情報がハードコードされないようにします。

セキュリティに関する考慮事項

• 資格情報管理: 環境変数またはシークレット管理システムを使用してデータベースの資格情報を保存します。
• 強力なパスワードポリシー: 安全なパスワードポリシーを設定し、弱いパスワードを避けます。
• ネットワークアクセス制御: データベースポートへのアクセスを制限し、必要なIPアドレスのみからの接続を許可します。
• SSL/TLS暗号化: SSL/TLS暗号化を有効にして、データ転送の安全性を確保します。

これらのベストプラクティスに従うことで、システムのセキュリティを大幅に向上させることができます。