# mysql_mcp_server_pro **Repository Path**: reference-project_1/mysql_mcp_server_pro ## Basic Information - **Project Name**: mysql_mcp_server_pro - **Description**: 支持SSE，STDIO；不仅止于mysql的增删改查功能； 还包含了数据库异常分析能力；且便于开发者们进行个性化的工具扩展 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 8 - **Created**: 2025-05-19 - **Last Updated**: 2025-05-29 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [![简体中文](https://img.shields.io/badge/简体中文-点击查看-orange)](README-zh.md) [![English](https://img.shields.io/badge/English-Click-yellow)](README.md) # mcp_mysql_server #### 帮忙点个赞啊，朋友们。 ## 介绍 mcp_mysql_server_pro 不仅止于mysql的增删改查功能，还包含了数据库异常分析能力，且便于开发者们进行个性化的工具扩展 - 支持 STDIO 方式 与 SSE 方式 - 支持 支持多sql执行，以";"分隔。 - 支持 根据表注释可以查询出对于的数据库表名，表字段 - 支持 sql执行计划分析 - 支持 中文字段转拼音. - 支持 锁表分析 - 支持 运行健康状态分析 - 支持权限控制，只读（readonly）、读写（writer）、管理员（admin） ``` "readonly": ["SELECT", "SHOW", "DESCRIBE", "EXPLAIN"], # 只读权限 "writer": ["SELECT", "SHOW", "DESCRIBE", "EXPLAIN", "INSERT", "UPDATE", "DELETE"], # 读写权限 "admin": ["SELECT", "SHOW", "DESCRIBE", "EXPLAIN", "INSERT", "UPDATE", "DELETE", "CREATE", "ALTER", "DROP", "TRUNCATE"] # 管理员权限 ``` - 支持 prompt 模版调用 ## 工具列表 | 工具名称 | 描述 | |-----------------------|------------------------------------------------------------------------------------------------------------------------------------| | execute_sql | sql执行工具，根据权限配置可执行["SELECT", "SHOW", "DESCRIBE", "EXPLAIN", "INSERT", "UPDATE", "DELETE", "CREATE", "ALTER", "DROP", "TRUNCATE"] 命令 | | get_chinese_initials | 将中文字段名转换为拼音首字母字段 | | get_db_health_running | 分析mysql的健康状态（连接情况、事务情况、运行情况、锁情况检测） | | get_table_desc | 根据表名搜索数据库中对应的表结构,支持多表查询 | | get_table_index | 根据表名搜索数据库中对应的表索引,支持多表查询 | | get_table_lock | 查询当前mysql服务器是否存在行级锁、表级锁情况 | | get_table_name | 根据表注释、表描述搜索数据库中对应的表名 | | get_db_health_index_usage | 获取当前连接的mysql库的索引使用情况,包含冗余索引情况、性能较差的索引情况、未使用索引且查询时间大于30秒top5情况| ## prompt 列表 | prompt名称 | 描述 | |----------------------------|------------------------------------------------------------------------------------------------------------------------------------| | analyzing-mysql-prompt | 这是分析mysql相关问题的提示词 | | query-table-data-prompt | 这是通过调用工具查询表数据的提示词，描述可以为空，空时则会初始化为mysql数据库数据查询助手 | ## 使用说明 ### pip安装和配置 1. 安装包 ```bash pip install mysql_mcp_server_pro ``` 2. 配置环境变量 创建一个 `.env` 文件，内容如下： ```bash # MySQL数据库配置 MYSQL_HOST=localhost MYSQL_PORT=3306 MYSQL_USER=your_username MYSQL_PASSWORD=your_password MYSQL_DATABASE=your_database # 可选值: readonly, writer, admin，默认为 readonly MYSQL_ROLE=readonly ``` 3. 运行服务 ```bash # SSE 模式 mysql_mcp_server_sse ``` 4. 在mcp 客户端配置上。详细看下方的sse启动 注意： - `.env` 文件应该放在运行命令的目录下 - 也可以直接在环境中设置这些变量 - 确保数据库配置正确且可以连接 ### 使用 uvx 运行，客户端配置 - 该方式直接在支持mcp 客户端上配置即可，无需下载源码。如通义千问插件，trae编辑工具等 ``` { "mcpServers": { "mysql": { "command": "uvx", "args": [ "--from", "mysql_mcp_server_pro", "mysql_mcp_server_pro" ], "env": { "MYSQL_HOST": "192.168.x.xxx", "MYSQL_PORT": "3306", "MYSQL_USER": "root", "MYSQL_PASSWORD": "root", "MYSQL_DATABASE": "a_llm", "MYSQL_ROLE": "admin" } } } } ``` ### 本地开发 SSE 方式 - 使用 uv 启动服务 将以下内容添加到你的 mcp client 工具中，例如cursor、cline等 mcp json 如下 ```` { "mcpServers": { "operateMysql": { "name": "operateMysql", "description": "", "isActive": true, "baseUrl": "http://localhost:9000/sse" } } } ```` 修改.env 文件内容,将数据库连接信息修改为你的数据库连接信息 ``` # MySQL数据库配置 MYSQL_HOST=192.168.xxx.xxx MYSQL_PORT=3306 MYSQL_USER=root MYSQL_PASSWORD=root MYSQL_DATABASE=a_llm MYSQL_ROLE=admin ``` 启动命令 ``` # 下载依赖 uv sync # 启动 uv run -m mysql_mcp_server_pro.server ``` ### 本地开发 STDIO 方式 将以下内容添加到你的 mcp client 工具中，例如cursor、cline等 mcp json 如下 ``` { "mcpServers": { "operateMysql": { "isActive": true, "name": "operateMysql", "command": "uv", "args": [ "--directory", "G:\\python\\mysql_mcp\\src", # 这里需要替换为你的项目路径 "run", "server.py", "--stdio" ], "env": { "MYSQL_HOST": "192.168.xxx.xxx", "MYSQL_PORT": "3306", "MYSQL_USER": "root", "MYSQL_PASSWORD": "root", "MYSQL_DATABASE": "a_llm", "MYSQL_ROLE": "admin" } } } } ``` ## 个性扩展工具 1. 在handles包中新增工具类，继承BaseHandler，实现get_tool_description、run_tool方法 2. 在__init__.py中引入新工具即可在server中调用 ## 工具调用示例 1. 创建新表以及插入数据 prompt格式如下 ``` # 任务 创建一张组织架构表，表结构如下：部门名称，部门编号，父部门，是否有效。 # 要求 - 表名用t_admin_rms_zzjg, - 字段要求：字符串类型使用'varchar(255)'，整数类型使用'int',浮点数类型使用'float'，日期和时间类型使用'datetime'，布尔类型使用'boolean'，文本类型使用'text'，大文本类型使用'longtext'，大整数类型使用'bigint'，大浮点数类型使用'double。 - 表头需要加入主键字段，序号 XH varchar(255) - 表最后需加入固定字段：创建人-CJR varchar(50)，创建时间-CJSJ datetime，修改人-XGR varchar(50)，修改时间-XGSJ datetime。 - 字段命名使用工具返回内容作为字段命名 - 常用字段需要添加索引 - 每个字段需要添加注释，表注释也需要 - 创建完成后生成5条真实数据 ``` ![image](https://github.com/user-attachments/assets/8a07007f-7375-4fb3-b69e-7ef9ffd68044) 2. 根据表注释查询数据 prompt如下 ``` 查询用户信息表中张三的数据 ``` ![image](https://github.com/user-attachments/assets/fb57aae3-1e50-4bc8-98d9-36e377cc9722) 3. 分析慢sql prompt如下 ``` select * from t_jcsjzx_hjkq_cd_xsz_sk xsz left join t_jcsjzx_hjkq_jcd jcd on jcd.cddm = xsz.cddm 根据当前的索引情况，查看执行计划提出优化意见，以markdown格式输出，sql相关的表索引情况、执行情况，优化意见 ``` 4. 分析sql卡死问题 prompt如下 ``` update t_admin_rms_zzjg set sfyx = '0' where xh = '1' 卡死了，请分析原因 ``` ![image](https://github.com/user-attachments/assets/e99576f0-a50f-457c-ad48-9e9c45391b89) 5. 分析健康状态 prompt如下 ``` 检测mysql当前的健康状态 ``` ![image](https://github.com/user-attachments/assets/156d91be-3140-4cf2-9456-c24eb268a0f0) ## prompt 调用示例 1. mysql 分析prompt 调用示例 - step1: 选择 analyzing-mysql-prompt ![image](https://github.com/user-attachments/assets/3be1ad59-2b1e-452b-bef4-564f0a754e74) - step2: 自动生成对应prompt ![image](https://github.com/user-attachments/assets/9438dba0-c003-4d14-bfe8-401f32f71b07) - step3: 开始问答 ![image](https://github.com/user-attachments/assets/9eefbb82-794d-4cb2-82e1-4debe237d86a) 2. 表数据查询 prompt 调用示例 - step1: 选择 query-table-data-prompt ![image](https://github.com/user-attachments/assets/768ff4cc-be89-42b0-802f-4e41f105db11) - step2: 输入问题描述（可选），不输入则会初始化为mysql数据查询助手 ![image](https://github.com/user-attachments/assets/968e7cfd-4dfe-47b5-9fc3-49cbf07a7a78) ![image](https://github.com/user-attachments/assets/3e1f80c1-2cff-471a-997a-94b8104e1b9b)