本项目提供了一个mysql - mcp服务器,可通过Docker或Python直接运行,具备丰富的数据库操作执行器,同时给出了安全使用的相关注意事项。
本项目提供了两种运行方式,你可以根据自己的需求进行选择。
# 启动数据库容器
docker-compose up -d db
# 构建并启动mysql-mcp-server(包括重建)
docker-compose up -d --build mysql-mcp-server
# 设置环境变量文件
cp .env.example .env
# 安装依赖项
pip install -r requirements.txt
# 运行服务器
python mysql_mcp_server/main.py run
MCPBoilerPlate/
├── mysql_mcp_server/ # 主应用目录
│ ├── executors/ # 数据库操作执行器
│ │ ├── create_table.py # 创建表工具
│ │ ├── desc_table.py # 查看表结构工具
│ │ ├── explain.py # 查询执行计划工具
│ │ ├── insert_query.py # 执行INSERT查询工具
│ │ ├── insight_starter.py # 写报告的架构验证工具
│ │ ├── invoke_viz_pro.py # 可视化图表推荐工具
│ │ ├── select_query.py # 执行SELECT查询工具
│ │ └── show_tables.py # 获取表列表工具
│ ├── helper/ # 工具模块
│ │ ├── db_conn_helper.py # 数据库连接管理工具
│ │ ├── logger_helper.py # 日志记录工具
│ │ └── tool_decorator.py # 工具装饰器
│ └── main.py # 应用入口点
├── docker-compose.yml # Docker Compose配置文件
├── Dockerfile # Docker镜像构建设置
├── requirements.txt # 依赖项列表
└── .env.example # 环境变量示例文件
⚠️ 重要提示
- 使用环境变量管理数据库凭证。
- 生产环境中使用强密码。
- 必要时考虑为数据库连接实施SSL/TLS加密。