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 文件。