Mysql MCP

🚀 zaj-MySQL-MCP

zaj-MySQL-MCP是一个基于MySQL实现的模型上下文协议（MCP）服务器，它能直接提供数据库交互和商业智能功能。该服务器支持执行SQL查询、分析业务数据，还能自动生成业务洞察报告，为业务决策提供有力支持。

✨ 主要特性

• 可执行针对MySQL数据库的SELECT查询。
• 能够创建和管理数据库表。
• 支持对数据库结构进行分析。
• 可以生成并存储业务洞察。
• 能访问持续更新的业务洞察报告。

📦 安装指南

请参考安装指南。

💻 使用示例

基础用法

以下是使用read_query工具执行SELECT查询的示例：

# 假设已经有了相应的数据库连接和工具调用环境
from some_module import read_query

query = "SELECT * FROM your_table"
result = read_query(query)
print(result)

高级用法

以下展示如何使用多个工具进行复杂操作，例如创建表、插入数据并查询：

# 假设已经有了相应的数据库连接和工具调用环境
from some_module import create_table, write_query, read_query

# 创建表
create_table_query = "CREATE TABLE test_table (id INT, name VARCHAR(255))"
create_table(create_table_query)

# 插入数据
insert_query = "INSERT INTO test_table (id, name) VALUES (1, 'example')"
write_query(insert_query)

# 查询数据
select_query = "SELECT * FROM test_table"
result = read_query(select_query)
print(result)

📚 详细文档

工具

查询工具

• read_query：执行SELECT查询以从数据库读取数据。
  • 输入：query (字符串) - 需要执行的SELECT SQL语句。
  • 返回：查询结果作为对象数组。
• write_query：执行INSERT、UPDATE或DELETE查询。
  • 输入：query (字符串) - 需要执行的修改数据库的SQL语句。
  • 返回：{ affected_rows: 数字 }。
• 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：用于处理标准输入输出通信。

服务器遵循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文件作为模板。复制并修改：

cp .env.example .env
# 然后编辑.env文件

📄 许可证

此MCP服务器根据MIT许可证发布。