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