Dpflucas Mysql MCP Server

🚀 MySQL 數據庫訪問 MCP 服務器

本 MCP 服務器提供對 MySQL 數據庫的只讀訪問服務。藉助它，你能夠輕鬆完成以下操作：

• 列出所有可用的數據庫。
• 在指定數據庫中查看所有表。
• 查看錶的詳細架構信息。
• 執行只讀的 SQL 查詢。

✨ 主要特性

• 只讀訪問：僅支持執行 SELECT、SHOW、DESCRIBE 和 EXPLAIN 語句，確保數據安全。
• 查詢驗證：有效防止 SQL 注入，阻止任何數據修改操作。
• 查詢超時：避免長時間運行的查詢佔用過多資源。
• 行限制：防止返回過多數據。

📦 安裝指南

方案1：通過 NPM 安裝（推薦）

# 全局安裝
npm install -g mysql-mcp-server

# 或者在項目中本地安裝
npm install mysql-mcp-server

方案2：從源碼構建

# 克隆倉庫
git clone https://github.com/dpflucas/mysql-mcp-server.git
cd mysql-mcp-server

# 安裝依賴項並構建
npm install
npm run build

3. 配置環境變量

服務器運行需要配置以下環境變量：

• MYSQL_HOST：數據庫服務器的主機名。
• MYSQL_PORT：數據庫服務器的端口，默認值為 3306。
• MYSQL_USER：數據庫的用戶名。
• MYSQL_PASSWORD：數據庫的密碼。
• MYSQL_DATABASE：默認數據庫名稱（可選）。

4. 添加到 MCP 設置

在 MCP 設置文件中添加如下配置： 如果通過 NPM 安裝（方案1）：

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["mysql-mcp-server"],
      "env": {
        "MYSQL_HOST": "${MYSQL_HOST}",
        "MYSQL_PORT": "${MYSQL_PORT}",
        "MYSQL_USER": "${MYSQL_USER}",
        "MYSQL_PASSWORD": "${MYSQL_PASSWORD}",
        "MYSQL_DATABASE": "${MYSQL_DATABASE}"
      }
    }
  }
}

如果從源碼構建（方案2）：

{
  "mcpServers": {
    "mysql": {
      "command": "node",
      "args": ["dist/index.js"],
      "env": {
        "MYSQL_HOST": "${MYSQL_HOST}",
        "MYSQL_PORT": "${MYSQL_PORT}",
        "MYSQL_USER": "${MYSQL_USER}",
        "MYSQL_PASSWORD": "${MYSQL_PASSWORD}",
        "MYSQL_DATABASE": "${MYSQL_DATABASE}"
      }
    }
  }
}

💻 使用示例

基礎用法

mysql-cli

通過命令行接口查詢數據庫，可使用以下參數：

• --host 或 -H：指定 MySQL 主機，默認為 localhost。
• --port 或 -P：指定 MySQL 端口，默認為 3306。
• --user 或 -u：指定 MySQL 用戶名。
• --password 或 -p：指定 MySQL 密碼。
• --database 或 -D：指定默認數據庫名稱。

mysql-rest

通過 REST API 查詢數據庫，需配置以下參數：

• port：指定服務器監聽的端口，默認為 3000。
• host：指定 MySQL 主機，默認為 localhost。
• user：指定 MySQL 用戶名。
• password：指定 MySQL 密碼。
• database：指定默認數據庫名稱。

mysql-dump

用於導出數據庫表結構和數據，示例如下：

# 導出所有表結構
./mysql-dump.sh --host=localhost --port=3306 --user=root --password=admin

# 導出特定數據庫的數據
./mysql-dump.sh --database=mydb > mydb_dump.sql

📚 詳細文檔

測試指南

準備工作

1. 創建測試數據庫 mcp_test_db，並確保測試用戶具備相應權限。
2. 確保所有環境變量已正確設置。

運行測試

單元測試

執行以下命令進行單元測試：

npm test

工具測試

執行以下命令測試工具功能：

npm run test:tools

故障排除

若遇到問題，可按以下步驟排查：

1. 查看服務器日誌，獲取詳細錯誤信息。
2. 驗證 MySQL 憑證和連接信息是否正確。
3. 確保 MySQL 用戶具備適當的權限。
4. 確認查詢為只讀且格式正確。

📄 許可證

本項目採用 MIT 許可證，詳細信息請查看 LICENSE 文件。