Mysql Server 5ac

🚀 MySQL 模板樣板項目

本項目是一個 MySQL 模板樣板項目，為數據庫操作提供了一套完整的架構和工具集，支持本地和 Docker 部署，方便開發者快速搭建和擴展數據庫應用。

🚀 快速開始

本地執行

# 配置環境
cp .env.example .env

# 修改 .env 文件以符合需求

# 安裝依賴項
pip install -r requirements.txt

# 啟動服務器
python mysql_mcp_server/main.py run

✨ 主要特性

• 分層架構設計：採用接口層、業務邏輯層和數據訪問層的分層結構，提高代碼的可維護性和擴展性。
• 豐富的數據庫操作工具：提供創建表、查看錶結構、執行查詢等多種數據庫操作工具。
• 支持 Docker 部署：方便在不同環境中快速部署和運行。
• 安全可靠：通過憑證管理、強密碼策略、網絡訪問控制和 SSL/TLS 加密等措施，保障系統安全。

📦 安裝指南

使用 Docker 運行

# 構建鏡像
docker build -t mysql-mcp .

# 啟動容器
docker run --name mysql-mcp-container -p 5000:5000 mysql-mcp

💻 使用示例

基礎用法

# 配置環境
cp .env.example .env

# 修改 .env 文件以符合需求

# 安裝依賴項
pip install -r requirements.txt

# 啟動服務器
python mysql_mcp_server/main.py run

高級用法

在 executors 目錄中實現新工具，並在 __init__.py 中註冊它們，以擴展數據庫操作功能。

📚 詳細文檔

目錄結構

以下是項目的目錄結構：

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 中註冊它們。

環境變量管理

使用環境變量管理憑證和配置，確保敏感信息不硬編碼。

🔧 技術細節

通信流程

1. AI 模型從 MCP 服務器請求可用工具的列表。
2. 服務器返回可用工具列表。
3. AI 模型請求執行特定工具。
4. 服務器調用相應的執行器進行數據庫操作。
5. 執行結果返回給 AI 模型。

擴展性和維護

在 executors 目錄中實現新工具，並在 __init__.py 中註冊它們，可實現工具的擴展。同時，使用環境變量管理憑證和配置，確保敏感信息不硬編碼，方便維護。

📄 許可證

文檔未提及許可證相關信息。

⚠️ 重要提示

請遵循安全考慮部分的最佳實踐，以提高系統的安全性。

💡 使用建議

在添加新工具時，確保在 executors 目錄中實現，並在 __init__.py 中註冊，以保證工具能正常使用。