article
README
🚀 MySQL MCP 服务器
MySQL MCP 服务器为 MySQL 数据库提供了结构化的接口,让 AI 模型能与之交互。它遵循 Model Context Protocol 规范,支持 Web 服务器和 CLI 两种运行模式。
🚀 快速开始
要使用 MySQL MCP 服务器,您可以选择使用 Smithery.ai 上发布的服务器,也可以在本地安装使用。
使用 Smithery.ai 上发布的服务器
- 访问服务器:访问 https://smithery.ai/server/@sussa3007/mysql-mcp
- 配置服务器:
- 设置 MySQL 数据库连接参数:
- MYSQL_HOST
- MYSQL_PORT
- MYSQL_USER
- MYSQL_PASSWORD
- MYSQL_DATABASE
- MYSQL_READONLY(可选,默认为 True 表示只读访问)
- 设置 MySQL 数据库连接参数:
- 与支持的 AI 平台连接:
- Anthropic Claude
- Cursor AI
- Windsurf
- Cline
- Witsy
- Enconvo
- Goose
- 身份验证:登录 Smithery.ai 以保存配置并生成认证令牌。
- 在 AI 提示中使用:连接后,您可以通过在 AI 对话中请求执行数据库操作来使用 MySQL 工具。
使用本地安装版本
安装:
npm install mysql-mcp
运行服务器:
mysql-mcp
默认情况下,服务器将在 http://localhost:3000 上运行。您可以访问 /api-docs 查看 API 文档。
✨ 主要特性
- MySQL 数据库连接管理
- SQL 查询执行
- 表格列表及结构检查
- 数据库列表及选择
- 实时状态监控通过 SSE(服务器发送事件)
- 提供用于测试 MCP 工具的 Web 接口
- 支持 stdio 和 SSE 两种传输方式
- Docker 部署就绪
📦 安装指南
# 全局安装
npm install -g mysql-mcp
# 本地安装
npm install mysql-mcp
💻 使用示例
基础用法
# 本地安装
npm install mysql-mcp
# 运行服务器
mysql-mcp
📚 详细文档
工具 - MCP 服务
| 属性 | 详情 | |------|------| | 名称 | mysql-mcp | | 版本 | 1.0.0 | | 描述 | MySQL 数据库的 MCP 适配器 | | 标签 | mysql, database, ai, model context protocol | | 入口文件 | dist/index.js |
功能
/ping
- 方法:GET
- 描述:检查服务是否可用
- 响应:
status: "ok"
/query
- 方法:POST
- 路径:/query
- 请求体:
{ "sql": "string" // 需要执行的 SQL 查询 } - 响应体:
{ "results": [...] // 查询结果 }
🔑 关键字
mysql, mcp, 数据库, ai, 模型上下文协议
📄 许可证
MIT
扫码联系在线客服