README
🚀 MySQL MCP 服务器
MySQL MCP 服务器是一个基于 Model Context Protocol (MCP) 的服务器,用于实现与 Cursor IDE 进行交互的 MySQL 数据库操作,为开发者提供便捷的数据库管理体验。
🚀 快速开始
安装及运行
- 安装所需的包:
npm install
- 启动服务器:
npm start
📦 安装指南
在启动服务器时,可以设置以下环境变量:
| 属性 | 详情 |
| ---- | ---- |
| MYSQL_HOST | MySQL 服务器主机 (默认值: "localhost") |
| MYSQL_PORT | MySQL 服务器端口 (默认值: 3306) |
| MYSQL_USER | MySQL 用户名 (默认值: "root") |
| MYSQL_PASSWORD | MySQL 密码 (默认值: "") |
| MYSQL_DATABASE | 默认数据库 (默认值: "test") |
| MYSQL_READONLY | 启用只读模式 ("true" 或 "false") |
💻 使用示例
与 Cursor IDE 配合使用
将 mcp.json 文件添加到 Cursor IDE 项目中,并按以下方式配置:
{
"mcpServers": {
"mysql": {
"command": "npx",
"args": [
"-y",
"github:comonetso/mysql-mcp-server"
],
"env": {
"MYSQL_HOST": "localhost",
"MYSQL_PORT": "3306",
"MYSQL_USER": "用户名",
"MYSQL_PASSWORD": "密码",
"MYSQL_DATABASE": "数据库名",
"MYSQL_READONLY": "true"
}
}
}
}
✨ 主要特性
- 执行 SQL 查询
- 查看表列表
- 表结构说明
- 数据库列表查看
- 切换数据库
- 连接状态检查
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group