Mysql Database Explorer

🚀 MySQL MCP 服務器文檔（中文版）

這是一個用於連接和管理 MySQL 數據庫的 MCP（MySQL Connection Pool）服務器的完整文檔。該服務器支持多種功能，包括只讀訪問、連接池配置以及高級測試工具。

🚀 快速開始

本服務器可助力你高效連接與管理 MySQL 數據庫，具備豐富功能，助你輕鬆應對數據庫操作。

📦 安裝指南

使用 NPM 安裝

通過以下命令即可完成安裝：

npm install mysql-mcp-server

從源碼構建

1. 克隆代碼倉庫：

   git clone https://github.com/username/mysql-mcp-server.git
   cd mysql-mcp-server
   

2. 安裝依賴項：

   npm install
   

📚 詳細文檔

配置環境變量

在 config.json 文件中設置以下環境變量：

{
  "MYSQL_HOST": "localhost",    // MySQL 服務器地址
  "MYSQL_PORT": 3306,          // MySQL 端口
  "MYSQL_USER": "root",        // 用戶名
  "MYSQL_PASSWORD": "password"  // 密碼
}

MCP 配置示例

在 mcp-config.json 文件中添加以下配置：

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["mysql-mcp-server"],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "root",
        "MYSQL_PASSWORD": "password",
        "MYSQL_DATABASE": "testDB"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

可用工具

列出數據庫

{
  "server_name": "mysql",
  "tool_name": "list_databases",
  "arguments": {}
}

列出表

{
  "server_name": "mysql",
  "tool_name": "list_tables",
  "arguments": {
    "database": "testDB"
  }
}

描述表

{
  "server_name": "mysql",
  "tool_name": "describe_table",
  "arguments": {
    "database": "testDB",
    "table": "users"
  }
}

執行查詢

{
  "server_name": "mysql",
  "tool_name": "execute_query",
  "arguments": {
    "database": "testDB",
    "query": "SELECT * FROM users LIMIT 10"
  }
}

高級連接池配置

在 config.json 中添加以下高級參數：

{
  "MYSQL_CONNECTION_LIMIT": 10,       // 連接池最大容量，默認為10
  "MYSQL_QUEUE_LIMIT": 0,             // 等待隊列的最大數量，默認為0（無限）
  "MYSQL_CONNECT_TIMEOUT": 10000,      // 連接超時時間，單位為毫秒，默認為10秒
  "MYSQL_IDLE_TIMEOUT": 60000,        // 空閒連接超時時間，單位為毫秒，默認為60秒
  "MYSQL_MAX_IDLE": 10               // 最大空閒連接數，默認為10
}

測試步驟

設置測試數據庫

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password

npm run test:setup

測試 MCP 工具

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password
export MYSQL_DATABASE=testDB

npm run test:tools

運行所有測試

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password

npm test

故障排除

1. 檢查服務器日誌以獲取錯誤信息。
2. 確認 MySQL 憑證和連接設置正確。
3. 確保 MySQL 用戶具有適當權限。
4. 確保查詢為只讀且格式正確。

📄 許可證

該軟件使用 MIT 許可證，具體許可證內容請參考 LICENSE 文件。