go-mcp-mysql

go-mcp-mysql

概述

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

请注意，此项目仍在开发中，可能尚不适合用于生产环境。

安装

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 替换为二进制文件的完整路径。例如：如果将二进制文件放在 Downloads 文件夹中，可以使用以下路径：

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

可选标志

• 添加 --read-only 标志以启用只读模式。在此模式下，只有以 list、read_ 和 desc_ 开头的工具可用。添加此标志后，请务必刷新或重启 MCP 服务。
• 默认情况下，CRUD 查询会先使用 EXPLAIN ? 语句执行，以检查生成的查询计划是否符合预期模式。添加 --with-explain-check 标志可禁用此行为。

工具

架构工具

1. list_database

   • 列出 MySQL 服务中的所有数据库。
   • 参数：无
   • 返回：匹配的数据库名称列表。

2. list_table

   • 列出 MySQL 服务中的所有表。
   • 参数：
     • name：如果提供，则列出名称与指定值匹配的表，等同于 SQL SHOW TABLES LIKE '%name%'。否则，列出所有表。
   • 返回：匹配的表名称列表。

3. create_table

   • 在 MySQL 服务中创建新表。
   • 参数：
     • query：用于创建表的 SQL 查询。
   • 返回：受影响的 x 行。

4. alter_table

   • 修改 MySQL 服务中的现有表。系统会告知大模型不要删除现有表或列。
   • 参数：
     • query：用于修改表的 SQL 查询。
   • 返回：受影响的 x 行。

5. desc_table

   • 描述表的结构。
   • 参数：
     • name：要描述的表的名称。
   • 返回：表的结构。

数据工具

1. read_query

   • 执行只读 SQL 查询。
   • 参数：
     • query：要执行的 SQL 查询。
   • 返回：查询结果。

2. write_query

   • 执行写入 SQL 查询。
   • 参数：
     • query：要执行的 SQL 查询。
   • 返回：受影响的 x 行，最后插入 ID：<last_insert_id>。

3. update_query

   • 执行更新 SQL 查询。
   • 参数：
     • query：要执行的 SQL 查询。
   • 返回：受影响的 x 行。

4. delete_query

   • 执行删除 SQL 查询。
   • 参数：
     • query：要执行的 SQL 查询。
   • 返回：受影响的 x 行。

许可证

MIT