README
🚀 MySQL MCP 服务器
MySQL MCP 服务器是一个基于模型上下文协议 (MCP) 的服务器,它为用户提供了便捷的 MySQL 数据库访问功能,满足多样化的数据操作需求。
🚀 快速开始
MySQL MCP 服务器为您提供了便捷的 MySQL 数据库访问功能。您可以通过以下步骤快速搭建并使用该服务器。
✨ 主要特性
- 🔍 列出数据库表及其架构,方便您快速了解数据库结构。
- 📄 执行只读 SQL 查询,确保数据的安全性。
- 🔒 安全连接处理及连接池,优化数据库连接性能。
📦 安装指南
- 克隆此仓库。
- 安装依赖:
npm install
- 构建项目:
npm run build
📚 详细文档
配置
设置以下环境变量:
| 属性 | 详情 |
|------|------|
| MYSQL_HOST | MySQL 服务器主机地址 |
| MYSQL_PORT | MySQL 服务器端口 |
| MYSQL_USER | MySQL 用户名 |
| MYSQL_PASS | MySQL 密码 |
| MYSQL_DB | MySQL 数据库名称 |
| MYSQL_SOCKET | MySQL 套接字路径(主机/端口的替代方案) |
| MYSQL_POOL_LIMIT | 连接池限制(默认值为 10) |
使用方法
服务器将在 MCP 系统初始化时自动启动。然后,您可以使用提供的工具和资源通过 MCP 接口访问。
📄 许可证
本项目采用 MIT 许可证。
Scan to contact