zaj-MySQL-MCP

一个模型上下文协议 (MCP) 服务器实现，通过 MySQL 提供数据库交互和商业智能功能。该服务器支持运行 SQL 查询、分析业务数据以及自动生成业务洞察备忘录。

功能

• 执行针对 MySQL 数据库的 SQL 查询
• 创建和管理数据库表
• 分析数据库模式
• 生成和存储业务洞察
• 访问持续更新的业务洞察备忘录

工具

查询工具

• read_query: 执行 SELECT 查询以从数据库读取数据

  • 输入: query (字符串) - 要执行的 SELECT SQL 查询
  • 返回: 查询结果作为对象数组

• write_query: 执行 INSERT、UPDATE 或 DELETE 查询

  • 输入: query (字符串) - SQL 修改查询
  • 返回: { affected_rows: number }

• create_table: 在数据库中创建新表

  • 输入: query (字符串) - CREATE TABLE SQL 语句
  • 返回: 表创建确认

模式工具

• list_tables: 获取数据库中所有表的列表

  • 无需输入
  • 返回: 表名数组

• describe_table: 查看特定表的模式信息

  • 输入: table_name (字符串) - 要描述的表的名称
  • 返回: 包含名称和类型的列定义数组

分析工具

• append_insight: 将新的业务洞察添加到备忘录资源
  • 输入: insight (字符串) - 从数据分析中发现的业务洞察
  • 返回: 洞察添加确认
  • 触发 memo://insights 资源的更新

资源

该服务器公开一个单一资源：

• memo://insights: 一个持续更新的业务洞察备忘录，聚合分析过程中发现的洞察
  • 通过 append-insight 工具发现新洞察时自动更新

实现细节

此 MCP 服务器直接实现模型上下文协议，而不依赖于外部 SDK 依赖项。它使用：

• mysql2: 用于 MySQL 数据库连接
• yargs: 用于命令行参数解析
• readline: 用于处理 stdin/stdout 通信

该服务器遵循 JSON-RPC 2.0 协议与 Claude 通信，处理工具列表、资源列表和工具执行的请求。

配置

MySQL MCP 服务器使用环境变量进行配置。在根目录中创建一个 .env 文件，其中包含以下变量：

# 数据库连接
DB_CONNECTION=mysql

# 数据库主机
DB_HOST=localhost

# 数据库端口
DB_PORT=3306

# 数据库用户名 (必需)
DB_USER=your_mysql_username

# 数据库密码 (必需)
DB_PASSWORD=your_mysql_password

# 数据库名称 (必需)
DB_NAME=your_database_name

提供了一个 .env.example 文件作为模板。将其复制到 .env 并更新值：

cp .env.example .env
# 然后使用您的数据库凭据编辑 .env

与 Claude Desktop 一起使用

将服务器添加到您的 cline_mcp_settings.json：

"mcpServers": {
  "mysql": {
    "command": "node",
    "args": [
      "/path/to/zaj_MySQL_MCP/build/index.js"
    ],
    "disabled": false,
    "autoApprove": []
  }
}

请注意，数据库凭据现在通过 .env 文件配置，而不是通过命令行参数。

构建和运行

1. 克隆存储库：

git clone https://github.com/zajTools/zaj-MySQL-MCP.git
cd zaj-MySQL-MCP

2. 创建并配置您的 .env 文件：

cp .env.example .env
# 使用您的数据库凭据编辑 .env

3. 安装依赖项：

npm install

4. 构建服务器：

npm run build

5. 运行服务器：

node build/index.js

演示和示例

我们提供了一些示例材料来帮助您开始使用 MySQL MCP 服务器：

• 示例数据库: 一个完整的电子商务数据库模式，包含客户、产品、订单和销售数据
• 示例查询: 预先编写的查询，演示了 MCP 服务器的各种功能
• 使用场景: Claude 如何与您的 MySQL 数据库交互的示例

要尝试演示：

1. 查看 演示指南 以获取分步说明
2. 运行 设置 SQL 脚本 以创建示例数据库
3. 配置 MCP 服务器以连接到演示数据库
4. 开始向 Claude 询问有关您数据的问题！

这些示例旨在展示将 Claude 与 MySQL 数据库结合使用的潜力，但 MCP 服务器适用于您可以访问的任何 MySQL 数据库。

许可证

此 MCP 服务器在 MIT 许可证下获得许可。