🚀 MySQL查询服务器

这是一个基于MCP（模型 - 控制器 - 提供者）框架构建的MySQL查询服务器，借助SSE（Server - Sent Events）技术，可实现高效的MySQL数据库操作，为数据交互提供了便捷且安全的解决方案。

🚀 快速开始

本MySQL查询服务器基于FastMCP框架构建，支持SSE实时数据传输，为你提供便捷的MySQL数据库查询服务。以下是启动服务器的基本步骤：

1. 确保系统已安装Python 3.6或更高版本。
2. 安装必要的依赖项：

pip install -r requirements.txt

3. 编辑config.ini文件，配置数据库连接信息。
4. 设置环境变量，例如：

export MYSQL_HOST=localhost MYSQL_PORT=3306 MYSQL_USER=root MYSQL_PASSWORD=root MYSQL_DB=testdb

5. 启动服务器：

python server.py

✨ 主要特性

• 先进框架支持：基于FastMCP框架构建，确保系统的高效性和可扩展性。
• 实时数据传输：支持SSE（Server - Sent Events），实现实时数据交互。
• 数据库查询接口：提供丰富的MySQL数据库查询接口，满足多样化需求。
• 完整日志记录：具备完整的日志记录系统，方便问题排查和系统监控。
• 自动事务管理：自动进行事务管理（提交/回滚），保障数据操作的一致性。
• 环境变量配置：支持通过环境变量进行灵活配置。
• 强大SQL安全机制：
  • 风险等级控制：系统自动评估SQL操作风险，并根据ALLOWED_RISK_LEVELS环境变量决定是否执行。
  • SQL注入防护：采用ORM（对象关系映射）框架和参数化查询，有效防止SQL注入攻击。
  • 危险操作拦截：拦截可能导致数据丢失的高风险操作（如TRUNCATE、DELETE等），需手动授权。
  • WHERE子句强制检查：所有查询必须包含有效的WHERE子句，确保查询目标明确。
  • 自动返回影响行数：自动返回修改操作影响的行数。

📦 安装指南

1. 安装Python：下载并安装Python 3.6或更高版本。
2. 安装依赖项：

pip install -r requirements.txt

3. 配置数据库：编辑config.ini文件，配置数据库连接信息。
4. 启动服务器：

python server.py

📚 详细文档

环境变量配置

服务器通过环境变量进行配置，常用环境变量及其作用如下：

SQL安全机制

服务器内置了强大的SQL安全机制，确保数据查询的安全性：

1. 风险等级控制：每个SQL操作的风险级别由系统自动评估，并根据ALLOWED_RISK_LEVELS环境变量决定是否允许执行。
2. SQL注入防护：使用ORM（对象关系映射）框架和参数化查询防止SQL注入攻击。
3. 危险操作拦截：对可能导致数据丢失的高风险操作（如TRUNCATE、DELETE等）进行拦截，需手动授权后方可执行。
4. WHERE子句强制检查：所有查询必须包含有效的WHERE子句，确保查询目标明确。

项目结构

mysql_query_server/
├── server.py                  # 主程序入口
├── config.ini                # 数据库配置文件
├── requirements.txt          # 依赖管理
└── README.md                 # 项目说明文档

常见问题解决

环境变量未生效

• 确保在server.py中调用load_dotenv()函数位于导入其他模块之前。
• 重启应用程序以确保环境变量被正确加载。

操作被安全机制拒绝

• 检查操作的风险级别是否超出允许范围。
• 如需执行高风险操作，调整ALLOWED_RISK_LEVELS配置。

不带WHERE条件的更新或删除

• 添加有效的WHERE子句以降低操作风险。

日志系统

服务器集成了一套完整的日志记录系统，支持控制台输出和文件记录。日志级别可通过修改server.py中的配置进行调整。

错误处理

服务器具备完善的错误处理机制：

• 数据库连接检查
• 配置验证
• SQL安全检查
• 运行时错误捕获与记录
• 自动事务回滚

📄 许可证

本项目采用MIT License：

允许任何人免费使用、复制、修改、合并、发布和销售本软件的副本，并允许用户进行上述操作，但需包含以下版权声明：

版权声明

版权所有 (c) 2024 MCP MySQL Query Server

无任何保证。由于本软件的使用或其它事项导致的索赔、损害或其他责任，作者或版权持有人不承担任何责任。

本软件按“原样”提供，不提供任何形式的明示或暗示的保证。

💡 贡献指南

欢迎通过提交Issue和Pull Request参与项目改进。