article
README
🚀 MySQL MCP 服务器
MySQL MCP 服务为 Cursor 提供了 MySQL 数据库连接与查询能力,让 Cursor AI 能直接访问 MySQL 数据库,通过标准化接口执行各类操作。
🚀 快速开始
MySQL MCP 服务是基于 Node.js 开发的 API 服务,遵循 MCP 协议规范,为 Cursor AI 提供直接访问 MySQL 数据库的能力。以下是启动服务的步骤:
前置条件
- Node.js 14.x 或更高版本
- 可连接的 MySQL 数据库
- Git(可选,用于克隆代码)
安装步骤
- 克隆代码仓库
git clone https://github.com/lichuanrong7/mysql-mcp-server.git
cd mysql-mcp-server
- 安装依赖项
npm install
- 配置环境变量
编辑
.env文件并填写您的 MySQL 数据库信息:
DB_HOST=你的数据库主机地址
DB_PORT=你的数据库端口号
DB_USER=你的数据库用户名
DB_PASSWORD=你的数据库密码
DB_NAME=你的数据库名称
- 启动服务器
npm start
✨ 主要特性
- SQL 查询执行:支持执行各种 SQL 语句(SELECT, INSERT, UPDATE, DELETE 等)
- 表结构查询:获取数据库表的详细结构信息
- 实时数据访问:为 AI 提供实时数据库访问能力
- 安全连接:支持通过环境变量配置数据库连接参数
- 跨域支持:内置 CORS 支持,便于前端应用集成
- 标准化响应:统一的 API 响应格式,简化集成和使用
- MCP 协议支持:完整实现 MCP 协议,方便与 Cursor AI 集成
🔧 技术细节
技术栈
- 运行环境:Node.js
- 主要框架:Express.js
- 数据库驱动:mysql2
- 环境变量:dotenv
- 跨域支持:cors
📋 配置
您可以根据需要进一步配置服务,例如:
- 修改
config.json文件以调整其他设置。 - 添加自定义中间件或路由。
⚠️ 注意事项
⚠️ 重要提示
- 确保 MySQL 数据库已正确配置并运行。
- 确保所有环境变量都已正确填写。
- 避免使用生产环境暴露开发环境中的敏感信息。
📚 详细文档
完整的 API 文档可以在 docs/api.md 找到,包括所有可用的端点和请求格式。
🛠️ 工具
为了更好地管理和部署此服务,建议使用以下工具:
- Docker:用于容器化部署。
- PM2:用于生产环境中的进程管理。
- Nginx:作为反向代理服务器。
📝 问题与贡献
欢迎报告任何问题或提交改进意见。请访问 GitHub 仓库 查看更多详细信息并参与讨论。
我们非常欢迎您为该项目做出贡献!请遵循以下步骤:
- Fork 此仓库
- 在您的 Fork 中创建功能分支(例如
feature/new-feature) - 提交您的更改
- 推送到 GitHub
- 创建 Pull Request
📄 许可证
本项目使用 MIT 许可证 - 详细信息请查看 LICENSE 文件
微信扫一扫