MySQL MCP 服务器

版本: 0.1.0

一个用于与 MySQL 数据库交互的模型上下文协议 (MCP) 服务器。 该服务器允许 MCP 客户端（如 AI 助手）查询和修改配置的 MySQL 数据库中的数据。

功能

• 使用标准连接参数连接到 MySQL 数据库。
• 提供 MCP 工具来执行 SQL 查询和语句。
• 支持只读查询 (SELECT, SHOW, DESCRIBE)。
• 通过单独的工具支持写操作 (INSERT, UPDATE, DELETE)，并通过环境变量 (MYSQL_ALLOW_WRITE_OPS) 进行控制。
• 通过标准输入/输出 (stdio) 进行通信。

安装

# 作为项目依赖项安装（推荐在另一个项目中使用）
npm install

# 或者，如果打算作为独立的全局工具：
# 1. 构建项目：
#    npm run build
# 2. 全局链接它：
#    npm link
#    (或者如果发布，则使用 `npm install -g .`)

配置

此服务器需要设置以下环境变量才能进行数据库连接：

• MYSQL_HOST: MySQL 服务器的主机名或 IP 地址。
• MYSQL_USER: 用于连接数据库的用户名。
• MYSQL_PASSWORD: 指定用户的密码。
• MYSQL_DATABASE: 要连接的数据库的名称。
• MYSQL_PORT: (可选) MySQL 服务器的端口号（默认为 3306）。
• MYSQL_ALLOW_WRITE_OPS: (可选) 设置为 true 以启用 insert、update 和 delete 工具。 默认为 false（禁用写操作）。 警告： 启用写操作允许 MCP 客户端修改您的数据库。 请谨慎使用。

这些变量需要在启动服务器进程的环境中可用。 如何设置它们取决于您的操作系统以及您如何运行服务器（例如，.env 文件、系统环境变量、shell export）。

用法

配置并构建 (npm run build) 后，您可以运行服务器：

# 如果全局链接
mysql-server

# 或者使用 node 直接运行
node build/index.js

服务器将启动并将 MySQL MCP server running on stdio 打印到 stderr，然后侦听标准输入/输出上的 MCP 请求。 您通常会配置您的 MCP 客户端（例如，AI 助手集成）以连接到此服务器进程。

可用工具

服务器公开以下工具供 MCP 客户端使用：

1. query

• 描述： 对配置的数据库执行只读 SQL 查询（SELECT、SHOW、DESCRIBE）。
• 输入模式：

  {
    "type": "object",
    "properties": {
      "sql": {
        "type": "string",
        "description": "要执行的只读 SQL 查询（SELECT、SHOW、DESCRIBE）。"
      }
    },
    "required": ["sql"]
  }
  

• 输出： 将查询结果作为 JSON 字符串在 MCP 响应 content 中返回。 如果查询不是只读的或者存在数据库错误，则返回错误。

2. insert

• 描述： 执行 INSERT SQL 语句。 需要将 MYSQL_ALLOW_WRITE_OPS 设置为 true。
• 输入模式：

  {
    "type": "object",
    "properties": {
      "sql": {
        "type": "string",
        "description": "要执行的 INSERT SQL 语句。"
      }
    },
    "required": ["sql"]
  }
  

• 输出： 返回包含受影响的行和插入 ID（如果适用）的成功消息，如果操作失败或禁用写操作，则返回错误消息。

3. update

• 描述： 执行 UPDATE SQL 语句。 需要将 MYSQL_ALLOW_WRITE_OPS 设置为 true。
• 输入模式：

  {
    "type": "object",
    "properties": {
      "sql": {
        "type": "string",
        "description": "要执行的 UPDATE SQL 语句。"
      }
    },
    "required": ["sql"]
  }
  

• 输出： 返回包含受影响的行的成功消息，如果操作失败或禁用写操作，则返回错误消息。

4. delete

• 描述： 执行 DELETE SQL 语句。 需要将 MYSQL_ALLOW_WRITE_OPS 设置为 true。
• 输入模式：

  {
    "type": "object",
    "properties": {
      "sql": {
        "type": "string",
        "description": "要执行的 DELETE SQL 语句。"
      }
    },
    "required": ["sql"]
  }
  

• 输出： 返回包含受影响的行的成功消息，如果操作失败或禁用写操作，则返回错误消息。

开发

要处理服务器代码：

1. 克隆存储库： (如果适用)

   # git clone <repository-url>
   # cd mysql-server
   

2. 安装依赖项：

   npm install
   

3. 构建代码： (将 TypeScript 编译为 build/ 中的 JavaScript)

   npm run build
   

4. 监视更改： (在更改时自动重新编译)

   npm run watch
   

5. 运行 MCP Inspector： (用于在本地测试/调试服务器)

   # 确保您已首先构建代码
   npm run inspector