MySQL数据库交互服务

一个基于MySQL的模型上下文协议(MCP)服务器实现,提供数据库交互和商业智能功能,包括执行SQL查询、分析业务数据和自动生成业务洞察备忘录。

  • by zajTools
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 zajtools/zaj-mysql-mcp

使用说明

zaj MySQL MCP

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

特性

  • 对MySQL数据库执行SQL查询
  • 创建和管理数据库表
  • 分析数据库架构
  • 生成和存储业务见解
  • 访问不断更新的业务洞察备忘录

工具

查询工具

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

    • 输入: query (string)-要执行的SELECT SQL查询
    • 返回:查询结果为对象数组
  • write_query:执行INSERT、UPDATE或DELETE查询

    • 输入: query (string)-SQL修改查询
    • 退货: { affected_rows: number }
  • create_table:在数据库中创建新表

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

架构工具

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

    • 无需输入
    • 返回:表名数组
  • describe_table:查看特定表的架构信息

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

分析工具

  • 附录_视图:为备忘录资源添加新的业务见解
    • 输入: insight (string)-从数据分析中发现的业务洞察力
    • 返回:确认洞察力添加
    • 触发器更新memo://insights资源

资源

服务器公开单个资源:

  • memo://insights:一份不断更新的业务见解备忘录,汇总了分析过程中发现的见解
    • 通过附加洞察工具发现新洞察时自动更新

实现细节

此MCP服务器直接实现模型上下文协议,不依赖于外部SDK依赖关系。它使用:

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

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

配置

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

# Database Connection
DB_CONNECTION=mysql

# Database Host
DB_HOST=localhost

# Database Port
DB_PORT=3306

# Database Username (required)
DB_USER=your_mysql_username

# Database Password (required)
DB_PASSWORD=your_mysql_password

# Database Name (required)
DB_NAME=your_database_name

A. .env.example 文件作为模板提供。复制到 .env 并更新值:

cp .env.example .env
# Then edit .env with your database credentials

使用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
  1. 创建并配置.env文件:
cp .env.example .env
# Edit .env with your database credentials
  1. 安装依赖项:
npm install
  1. 构建服务器:
npm run build
  1. 运行服务器:
node build/index.js

演示和示例

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

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

要尝试演示:

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

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

许可证

此MCP服务器根据MIT许可证获得许可。