MySQL MCP Server

MySQL查询服务器 / MySQL Query Server

1. 项目简介 / Project Introduction

本项目是基于MCP框架的MySQL查询服务器，支持通过SSE协议进行实时数据库操作，具备完善的安全、日志、配置和敏感信息保护机制，适用于开发、测试和生产环境下的安全MySQL数据访问。

This project is a MySQL query server based on the MCP framework, supporting real-time database operations via SSE protocol. It features comprehensive security, logging, configuration, and sensitive information protection mechanisms, suitable for secure MySQL data access in development, testing, and production environments.

2. 主要特性 / Key Features

• 基于FastMCP框架，异步高性能
• 支持高并发的数据库连接池，参数灵活可调
• 支持SSE实时推送
• 丰富的MySQL元数据与结构查询API
• 自动事务管理与回滚
• 多级SQL风险控制与注入防护
• 敏感信息自动隐藏与自定义
• 灵活的环境变量配置
• 完善的日志与错误处理
• Docker支持，快速部署
• Built on FastMCP framework, high-performance async
• Connection pool for high concurrency, with flexible parameter tuning
• SSE real-time push support
• Rich MySQL metadata & schema query APIs
• Automatic transaction management & rollback
• Multi-level SQL risk control & injection protection
• Automatic and customizable sensitive info masking
• Flexible environment variable configuration
• Robust logging & error handling
• Docker support for quick deployment

3. 快速开始 / Quick Start

Docker 方式 / Docker Method

Windows PowerShell 格式：

源码方式 / Source Code Method

安装依赖 / Install Dependencies

配置环境变量 / Configure Environment Variables

复制.env.example为.env，并根据实际情况修改。 Copy .env.example to .env and modify as needed.

启动服务 / Start the Server

默认监听：http://127.0.0.1:3000/sse Default endpoint: http://127.0.0.1:3000/sse

4. 目录结构 / Project Structure

5. 环境变量与配置 / Environment Variables & Configuration

注/Note: 部分云MySQL需指定DB_AUTH_PLUGIN为mysql_native_password。

6. 自动化与资源管理优化 / Automation & Resource Management Enhancements

自动化工具注册 / Automated Tool Registration

• 所有MySQL相关API工具均采用自动注册机制：
  • 无需手动在主入口维护注册代码，新增/删除工具只需在src/tools/目录下实现register_xxx_tool(s)函数即可。
  • 系统启动时自动扫描并注册，极大提升可维护性和扩展性。
• All MySQL-related API tools are registered automatically:
  • No need to manually maintain registration code in the main entry. To add or remove a tool, simply implement a register_xxx_tool(s) function in the src/tools/ directory.
  • The system scans and registers tools automatically at startup, greatly improving maintainability and extensibility.

连接池自动回收与资源管理 / Connection Pool Auto-Recycling & Resource Management

• 连接池采用事件循环隔离与自动回收机制：
  • 每个事件循环独立池，支持高并发与多环境。
  • 定期（默认每5分钟）自动回收无效或失效的连接池，防止资源泄漏。
  • 事件循环关闭时自动关闭对应连接池，确保资源彻底释放。
  • 支持多数据库/多租户场景扩展。
• 所有资源管理操作均有详细日志，便于追踪和排查。
• The connection pool uses event loop isolation and auto-recycling:
  • Each event loop has its own pool, supporting high concurrency and multi-environment deployment.
  • Unused or invalid pools are automatically recycled every 5 minutes (by default), preventing resource leaks.
  • When an event loop is closed, its pool is automatically closed to ensure complete resource release.
  • Ready for multi-database/multi-tenant scenarios.
• All resource management operations are logged in detail for easy tracking and troubleshooting.

7. 安全机制 / Security Mechanisms

• 多级SQL风险等级（LOW/MEDIUM/HIGH/CRITICAL）
• SQL注入与危险操作拦截
• WHERE子句强制检查
• 敏感信息自动隐藏（支持自定义字段）
• 生产环境默认只允许低风险操作
• Multi-level SQL risk levels (LOW/MEDIUM/HIGH/CRITICAL)
• SQL injection & dangerous operation interception
• Mandatory WHERE clause check
• Automatic sensitive info masking (customizable fields)
• Production allows only low-risk operations by default

8. 日志与错误处理 / Logging & Error Handling

• 日志级别可配置（LOG_LEVEL）
• 控制台与文件日志输出
• 详细记录运行状态与错误
• 完善的异常捕获与事务回滚
• Configurable log level (LOG_LEVEL)
• Console & file log output
• Detailed running status & error logs
• Robust exception capture & transaction rollback

9. 常见问题 / FAQ

Q: DELETE操作未执行成功？

A: 检查是否有WHERE条件，无WHERE为高风险，需在ALLOWED_RISK_LEVELS中允许CRITICAL。

Q: Why does DELETE not work? A: Check for WHERE clause. DELETE without WHERE is high risk (CRITICAL), must be allowed in ALLOWED_RISK_LEVELS.

Q: 如何自定义敏感字段？

A: 设置SENSITIVE_INFO_FIELDS，如SENSITIVE_INFO_FIELDS=password,token

Q: How to customize sensitive fields? A: Set SENSITIVE_INFO_FIELDS, e.g. SENSITIVE_INFO_FIELDS=password,token

Q: limit参数报错？

A: limit必须为非负整数。

Q: limit parameter error? A: limit must be a non-negative integer.

10. 贡献指南 / Contribution Guide

欢迎通过Issue和Pull Request参与改进。 Contributions via Issue and Pull Request are welcome.

11. 许可证 / License

MIT License

本软件按"原样"提供，不提供任何形式的明示或暗示的保证，包括但不限于对适销性、特定用途的适用性和非侵权性的保证。在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权行为还是其他方面，产生于、源于或与本软件有关，或与本软件的使用或其他交易有关。
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.