Mysql MCP Server

🚀 MySQL MCP 服務器

MySQL MCP 服務器實現了模型上下文協議（MCP），讓 AI 應用程序與 MySQL 數據庫能進行安全交互。該服務器組件藉助受控接口，促進 AI 應用程序（主機/客戶端）和 MySQL 數據庫之間的通信，讓數據庫的探索與分析更安全、更具結構化。

🚀 快速開始

MySQL MCP 服務器並非獨立運行的服務器，而是作為 AI 應用程序與 MySQL 數據庫之間通信協議的實現組件。

✨ 主要特性

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

📦 安裝指南

手動安裝

pip install mysql-mcp-server

使用 Smithery 安裝

自動通過 Smithery 安裝 MySQL MCP Server 以供 Claude 桌面使用：

npx -y @smithery/cli install mysql-mcp-server --client claude

🛠️ 配置

設置以下環境變量：

MYSQL_HOST=localhost     # 數據庫主機
MYSQL_PORT=3306         # 可選：數據庫端口（未指定時默認為 3306）
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

💻 使用示例

基礎用法

在 Claude 桌面中使用

將以下內容添加到 claude_desktop_config.json：

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

在 Visual Studio Code 中使用

配置 launch.json 文件以支持調試：

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "啟動 MySQL MCP 服務器",
      "type": "python",
      "request": "launch",
      "program": "path/to/mysql_mcp_server/__main__.py",
      "args": []
    }
  ]
}

👨‍💻 開發

要為項目做出貢獻，請按照以下步驟操作：

1. 克隆倉庫：git clone https://github.com/yourusername/mysql-mcp-server.git
2. 安裝依賴項：pip install -r requirements.txt
3. 啟動測試環境：pytest tests/

⚠️ 安全注意事項

• 切勿提交環境變量或憑證到版本控制系統。
• 使用 HTTPS 保護數據庫連接。
• 定期更新數據庫憑據。

💡 最佳實踐

• 避免在生產環境中暴露數據庫端口。
• 使用防火牆限制數據庫訪問。
• 配置審計日誌以監控敏感操作。

📄 許可證

項目使用 MIT License。

🤝 貢獻指南

1. 克隆倉庫：git clone https://github.com/yourusername/mysql-mcp-server.git
2. 創建功能分支：git checkout -b feature/amazing-feature
3. 提交更改：git commit -m '實現驚人的新特性'
4. 推送到分支：git push origin feature/amazing-feature
5. 提交拉取請求

通過遵循這些步驟，您可以為項目的發展做出寶貴貢獻。