MySQL查询服务器

这是一个基于MCP（模型-控制器-提供者）框架构建的MySQL查询服务器，提供了通过SSE（Server-Sent Events）进行MySQL数据库操作的功能。

功能特点

• 基于FastMCP框架构建
• 支持SSE（Server-Sent Events）实时数据传输
• 提供MySQL数据库查询接口
• 完整的日志记录系统
• 自动事务管理（提交/回滚）
• 环境变量配置支持
• SQL安全检查机制
  • 风险等级控制
  • SQL注入防护
  • 危险操作拦截
  • WHERE子句强制检查
  • 自动返回修改操作影响的行数

系统要求

• Python 3.6+
• MySQL数据库

安装步骤

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

   pip install -r requirements.txt
   

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

   python server.py
   

环境变量配置

服务器通过环境变量进行配置。以下是常用的环境变量及其作用：

• DB_HOST: MySQL数据库的主机地址，默认为localhost。
• DB_PORT: MySQL数据库的端口号，默认为3306。
• DB_USER: 连接MySQL数据库的用户名。
• DB_PASSWORD: MySQL用户的密码。
• DB_NAME: 使用的数据库名称。

SQL安全机制

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

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

启动服务器

1. 确保环境变量已正确设置：

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

2. 启动服务器：

   python server.py
   

项目结构

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

常见问题解决

1. 环境变量未生效

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

2. 操作被安全机制拒绝

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

3. 不带WHERE条件的更新或删除

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

日志系统

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

错误处理

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

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

贡献指南

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

许可证

本项目采用MIT License：

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

版权声明

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

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

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