mysql-mcp-server

mysql-mcp-server

site icon
2025.03.23 0
Python数据库管理数据分析数据库
MCP MySQL Server 是一个基于 MCP(Model Context Protocol)的 MySQL 数据库操作服务器应用。该服务器提供了一系列工具,允许 AI 模型与 MySQL 数据库进行交互。核心功能包括数据库表创建、表结构查看、查询执行计划、数据插入和查询等。适用于需要 AI 模型与 MySQL 数据库交互的场景,如数据分析、报告生成等。
View on GitHub

Overview

基本能力

产品定位

MCP MySQL Server 是一个用于 MySQL 数据库操作的服务器应用,基于 MCP(Model Context Protocol),允许 AI 模型与 MySQL 数据库进行交互。

核心功能

  1. 数据库操作工具
  2. 创建表 (execute_create_table)
  3. 查看表结构 (execute_desc_table)
  4. 查询执行计划 (execute_explain)
  5. 执行 INSERT 查询 (execute_insert_query)
  6. 执行 SELECT 查询 (execute_select_query)
  7. 获取表列表 (execute_show_tables)
  8. 数据分析和报告生成 (execute_insight_starter)
  9. 可视化图表推荐 (execute_invoke_viz_pro)

  10. 技术栈

  11. 语言:Python
  12. 数据库:MySQL 8.0
  13. 关键库:mcp、PyMySQL、pandas、python-dotenv、fire

  14. 部署方式:支持 Docker、Docker Compose 和直接通过 Python 运行。

适用场景

  • AI 模型与 MySQL 数据库的交互
  • 数据分析和报告生成
  • 数据库管理和操作

工具列表

  1. execute_create_table:创建数据库表。
  2. execute_desc_table:查看表结构。
  3. execute_explain:获取查询执行计划。
  4. execute_insert_query:执行 INSERT 查询。
  5. execute_select_query:执行 SELECT 查询。
  6. execute_show_tables:获取数据库中的表列表。
  7. execute_insight_starter:检查表结构以生成报告。
  8. execute_invoke_viz_pro:推荐可视化图表。

常见问题解答

  • 依赖问题:确保安装了所有依赖库(通过 pip install -r requirements.txt)。
  • 数据库连接问题:检查 .env 文件中的数据库连接配置。
  • 工具注册问题:新工具需要在 executors/__init__.py 中导入并添加到 __all__ 数组。

使用教程

使用依赖

  1. 安装 Python 3.x
  2. 安装 Docker(如需使用 Docker 运行)

安装教程

通过 Docker 运行

docker run -d --name mcp-mysql \
  -e MYSQL_HOST=localhost \
  -e MYSQL_PORT=3306 \
  -e MYSQL_USER=root \
  -e MYSQL_PASSWORD=mcpTest1234!!! \
  -e MYSQL_DATABASE=mcp_test \
  -e MCP_PORT=8081 \
  -p 3306:3306 mineru/mcp-mysql:1.0.0

通过 Docker Compose 运行

docker-compose up -d

直接通过 Python 运行

pip install -r requirements.txt
python mysql_mcp_server/main.py run

调试方式

  1. 检查日志输出: bash docker logs mcp-mysql
  2. 检查数据库连接: bash mysql -h localhost -P 3306 -u root -p
  3. 测试工具列表: bash curl http://localhost:8081/tools

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。