article
README
🚀 MCP MySQL 本地数据库服务
MCP MySQL 服务是一款轻量级程序,专为个人用户打造。它主要用于连接并操作本地的 MySQL 数据库,还能作为 Cursor 的 MCP 服务,借助 API 接口让 Cursor 可以轻松执行各类数据库操作。
🚀 快速开始
前置条件
- Node.js (v14+)
- MySQL 服务器
📦 安装指南
- 克隆此仓库
- 安装依赖
npm install - 创建并配置
.env文件# 服务器配置 PORT=3000 NODE_ENV=development # MySQL 数据库配置 DB_HOST=localhost DB_PORT=3306 DB_USER=你的用户名 DB_PASSWORD=你的密码 DB_NAME=你的数据库名 # API 配置 API_KEY=你的 API 密钥
运行
npm start
开发模式(自动重启):
npm run dev
✨ 主要特性
- 连接本地 MySQL 数据库
- 提供 RESTful API 进行数据库操作
- 支持参数化查询以防止 SQL 注入
- 支持 SSE(服务器发送事件)推送能力
- 支持作为 Cursor MCP 服务集成
📚 详细文档
📄 API文档
获取所有数据库
GET /api/databases
获取数据库的所有表
GET /api/databases/:database/tables
获取表结构
GET /api/databases/:database/tables/:table/structure
执行查询
POST /api/query
Content-Type: application/json
{
"sql": "SELECT * FROM users WHERE age > ?",
"params": [18],
"limit": 10,
"offset": 0
}
SSE 连接
GET /api/sse?apiKey=your-api-key
💻 使用示例
在 Cursor 中使用
SSE 方式
{
"name": "MySQL 数据库服务",
"url": "http://localhost:3000/api/sse",
"type": "sse"
}
Command 方式
{
"name": "MySQL 数据库服务",
"command": "node /path/to/mcp_server_mysql/src/app.js",
"type": "command"
}
🔧 技术细节
- 此服务仅限本地使用,不建议暴露到公网
- 使用 API 密钥保护接口
- 默认只允许执行 SELECT 查询
📄 许可证
MIT
微信扫一扫