Mangooer Mysql MCP Server Sse

🚀 MySQL查詢服務器

這是一個基於MCP（模型 - 控制器 - 提供者）框架構建的MySQL查詢服務器，藉助SSE（Server - Sent Events）技術，可實現高效的MySQL數據庫操作，為數據交互提供了便捷且安全的解決方案。

🚀 快速開始

本MySQL查詢服務器基於FastMCP框架構建，支持SSE即時數據傳輸，為你提供便捷的MySQL數據庫查詢服務。以下是啟動服務器的基本步驟：

1. 確保系統已安裝Python 3.6或更高版本。
2. 安裝必要的依賴項：

pip install -r requirements.txt

3. 編輯config.ini文件，配置數據庫連接信息。
4. 設置環境變量，例如：

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

5. 啟動服務器：

python server.py

✨ 主要特性

• 先進框架支持：基於FastMCP框架構建，確保系統的高效性和可擴展性。
• 即時數據傳輸：支持SSE（Server - Sent Events），實現即時數據交互。
• 數據庫查詢接口：提供豐富的MySQL數據庫查詢接口，滿足多樣化需求。
• 完整日誌記錄：具備完整的日誌記錄系統，方便問題排查和系統監控。
• 自動事務管理：自動進行事務管理（提交/回滾），保障數據操作的一致性。
• 環境變量配置：支持通過環境變量進行靈活配置。
• 強大SQL安全機制：
  • 風險等級控制：系統自動評估SQL操作風險，並根據ALLOWED_RISK_LEVELS環境變量決定是否執行。
  • SQL注入防護：採用ORM（對象關係映射）框架和參數化查詢，有效防止SQL注入攻擊。
  • 危險操作攔截：攔截可能導致數據丟失的高風險操作（如TRUNCATE、DELETE等），需手動授權。
  • WHERE子句強制檢查：所有查詢必須包含有效的WHERE子句，確保查詢目標明確。
  • 自動返回影響行數：自動返回修改操作影響的行數。

📦 安裝指南

1. 安裝Python：下載並安裝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子句，確保查詢目標明確。

項目結構

mysql_query_server/
├── server.py                  # 主程序入口
├── config.ini                # 數據庫配置文件
├── requirements.txt          # 依賴管理
└── README.md                 # 項目說明文檔

常見問題解決

環境變量未生效

• 確保在server.py中調用load_dotenv()函數位於導入其他模塊之前。
• 重啟應用程序以確保環境變量被正確加載。

操作被安全機制拒絕

• 檢查操作的風險級別是否超出允許範圍。
• 如需執行高風險操作，調整ALLOWED_RISK_LEVELS配置。

不帶WHERE條件的更新或刪除

• 添加有效的WHERE子句以降低操作風險。

日誌系統

服務器集成了一套完整的日誌記錄系統，支持控制檯輸出和文件記錄。日誌級別可通過修改server.py中的配置進行調整。

錯誤處理

服務器具備完善的錯誤處理機制：

• 數據庫連接檢查
• 配置驗證
• SQL安全檢查
• 運行時錯誤捕獲與記錄
• 自動事務回滾

📄 許可證

本項目採用MIT License：

允許任何人免費使用、複製、修改、合併、發佈和銷售本軟件的副本，並允許用戶進行上述操作，但需包含以下版權聲明：

版權聲明

版權所有 (c) 2024 MCP MySQL Query Server

無任何保證。由於本軟件的使用或其它事項導致的索賠、損害或其他責任，作者或版權持有人不承擔任何責任。

本軟件按“原樣”提供，不提供任何形式的明示或暗示的保證。

💡 貢獻指南

歡迎通過提交Issue和Pull Request參與項目改進。