概述

零负担、即用型模型上下文协议（MCP）服务器，用于与MySQL交互和自动化。无需Node.js或Python环境。此服务器提供工具来对MySQL数据库和表执行CRUD操作，并提供只读模式以防止意外写入操作。您还可以启用检查查询计划的功能，方法是在执行查询之前使用EXPLAIN语句，通过添加--with-explain-check标志。

请注意，这是一个正在进行中的项目，可能尚未准备好投入生产环境使用。

安装

1. 下载最新发布版本，并将其放在您的$PATH中或放在您可以轻松访问的位置。

2. 或者如果您已经安装了Go，则可以从源代码构建：

go install -v github.com/Zhwt/go-mcp-mysql@latest

使用方法

方法A：使用命令行参数

{
  "mcpServers": {
    "mysql": {
      "command": "go-mcp-mysql",
      "args": [
        "--host", "localhost",
        "--user", "root",
        "--pass", "password",
        "--port", "3306",
        "--db", "mydb"
      ]
    }
  }
}

方法B：使用带自定义选项的DSN

{
  "mcpServers": {
    "mysql": {
      "command": "go-mcp-mysql",
      "args": [
        "--dsn", "username:password@tcp(localhost:3306)/mydb?parseTime=true&loc=Local"
      ]
    }
  }
}

请参阅MySQL DSN以获取更多详细信息。

注意：如果将二进制文件放在不在$PATH中的位置，需要用完整路径替换go-mcp-mysql。例如：如果您将二进制文件放在下载文件夹中，则可以使用以下路径：

{
  "mcpServers": {
    "mysql": {
      "command": "C:\\Users\\<username>\\Downloads\\go-mcp-mysql.exe",
      "args": [
        ...
      ]
    }
  }
}

可选标志

• 添加--read-only标志以启用只读模式。在此模式下，仅允许以list、read_和desc_开头的工具使用。请确保在添加此标志后刷新/重新启动。
• 启用检查查询计划功能，方法是在执行查询之前使用EXPLAIN语句：

# 检查单条查询
go-mcp-mysql --dsn "root:password@tcp(localhost:3306)/test" --with-explain -sql "SELECT * FROM user"

# 启用检查所有查询
export GMCP_CHECK_QUERY=true

工具

Schema Tools

mysql-backup

• 功能: 备份指定数据库的所有表结构。

• 参数:

  • --src-dsn: 源数据库连接字符串（必填）。
  • --dest-filename: 输出文件名，格式为{db}_{table}.sql（可选，默认为stdout）。

• 示例:

  mysql-backup --src-dsn "root:password@tcp(localhost:3306)/test"
  

Data Tools

mysql-import

• 功能: 将SQL文件导入到指定数据库。

• 参数:

  • --dsn: 数据库连接字符串（必填）。
  • --filename: 输入文件路径（必填）。

• 示例:

  mysql-import --dsn "root:password@tcp(localhost:3306)/test" --filename user.sql
  

mysql-export

• 功能: 将指定数据库的所有表导出为SQL文件。

• 参数:

  • --src-dsn: 源数据库连接字符串（必填）。
  • --dest-filename: 输出文件名，格式为{db}_{table}.sql（可选，默认为stdout）。

• 示例:

  mysql-export --src-dsn "root:password@tcp(localhost:3306)/test"
  

许可证

该项目采用MIT许可证。