Designcomputer Mysql MCP Server

🚀 MySQL MCP 服務器

MySQL MCP 服務器是一個符合 Model Context Protocol (MCP) 標準的服務器，它能夠實現與 MySQL 數據庫的安全交互。藉助該服務器，AI 助手可以列出表格、讀取數據，並通過受控接口執行 SQL 查詢，從而更安全地對數據庫進行探索和分析。

🚀 快速開始

本服務器可與 Claude Desktop 集成，也能作為獨立服務器運行，具體操作步驟見下方“使用示例”部分。

✨ 主要特性

• 🔖 列出可用的 MySQL 表作為資源
• 📖 讀取消息表的內容
• 🛠️ 執行帶錯誤處理的 SQL 查詢
• 🔐 通過環境變量實現數據庫訪問的安全控制
• 📝 全面的日誌記錄

📦 安裝指南

使用以下命令安裝 mysql-mcp-server：

pip install mysql-mcp-server

💻 使用示例

基礎用法

與 Claude Desktop 集成

在 claude_desktop_config.json 文件中添加以下內容：

{
  "mcpServers": {
    "mysql": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/mysql_mcp_server",
        "run",
        "mysql_mcp_server"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_USER": "your_username",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

作為獨立服務器運行

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

# 運行服務器
python -m mysql_mcp_server

高級用法

開發環境搭建

# 克隆倉庫
git clone https://github.com/yourusername/mysql_mcp_server.git
cd mysql_mcp_server

# 創建虛擬環境
python -m venv venv
source venv/bin/activate  # 或 `venv\Scripts\activate` 在 Windows 上

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

# 運行測試
pytest

📚 詳細文檔

配置

在使用前，需要設置以下環境變量：

MYSQL_HOST=localhost
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

安全注意事項

• 🔒 永遠不要提交環境變量或憑據
• 👤 使用權限最小的 MySQL 用戶
• 📃 考慮在生產環境中實施查詢白名單
• 📋 監控並記錄所有數據庫操作

最佳安全實踐

此 MCP 服務器需要數據庫訪問權限才能運行。出於安全考慮，建議遵循以下步驟：

1. 👤 創建一個專用的 MySQL 用戶，賦予其最小權限
2. 🚫 避免使用 root 賬戶或管理賬戶
3. 📌 限制數據庫訪問，僅允許必要的操作
4. 📝 啟用日誌記錄 用於審核目的
5. 🔍 定期進行安全審查 對數據庫訪問進行檢查

請參考 MySQL 安全配置指南 獲取更多詳細說明，包括：

• 創建受限的 MySQL 用戶
• 設置適當的權限
• 監控數據庫訪問
• 其他安全最佳實踐

⚠️ 重要提示

在配置數據庫訪問時，始終遵循最小特權原則。

貢獻

如果你想為項目做出貢獻，可以按照以下步驟操作：

1. Fork 倉庫
2. 創建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打開 Pull Request

📄 許可證

本項目採用 MIT License，有關詳細信息，請參閱 LICENSE 文件。