mcp-mysql-server

基本能力

产品定位

mcp-mysql-server 是一个轻量级的 MySQL 数据库交互工具，专注于本地开发环境中的数据库查询和模式检查。

核心功能

• 查询执行：执行 SQL SELECT 语句并以简单可读的格式查看结果。
• 数据操作：通过 write_table 工具向表中插入数据。
• 模式检查：
• 使用 list_tables 工具列出所有表。
• 使用 get_table_schema 工具显示特定表的列及其数据类型。
• 连接测试：测试数据库连接并获取服务器信息。
• 可配置的访问控制：通过配置文件定义连接参数（主机、用户、密码、数据库），实现安全的数据库访问。
• stdio 接口：使用标准输入输出进行交互，便于脚本化和自动化。
• 本地部署优化：专为本地开发环境设计。

适用场景

• 本地开发环境中的数据库查询和操作。
• 数据库模式的快速检查和调试。
• 自动化脚本中集成数据库操作。

工具列表

• test_connection：测试数据库连接并返回服务器信息。
• list_tables：列出当前数据库中的所有表。
• read_table：读取并返回指定表的所有数据。
• write_table：向指定表插入新数据行。
• get_table_schema：返回指定表的模式（列定义）。
• execute_sql：执行自定义 SQL 查询并返回结果。

常见问题解答

• 如何配置数据库连接？ 创建 config.ini 文件并填写 MySQL 连接参数。
• 如何运行脚本？ 使用命令 python mcp-mysql-server.py --config config.ini。
• 如何添加新功能？ 通过创建新的 Python 函数并使用 @mcp.tool() 装饰器来扩展工具。

使用教程

使用依赖

• Python 3.x
• 本地 MySQL 服务器实例
• 安装依赖库： bash pip install -r requirements.txt

安装教程

1. 下载或克隆仓库到本地机器。
2. 创建配置文件 config.ini，格式如下： ini [mysql] host = localhost port = 3306 user = your_mysql_user password = your_mysql_password database = your_database_name
3. 运行脚本： bash python mcp-mysql-server.py --config config.ini

调试方式

• 运行单元测试： bash cp mcp-mysql-server.py mcp_mysql_server.py python -m unittest tests.py
• 使用 Docker 运行测试： bash docker-compose -f docker-compose.test.yml up --build

许可证

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