🚀 MySQL MCP 服务器
MySQL MCP 服务器是一个提供只读访问 MySQL 数据库的模型上下文协议（Model Context Protocol）服务器。它让大型语言模型（LLM）能够查看数据库架构并执行只读查询，为数据交互提供了便利。
🚀 快速开始
MySQL MCP 服务器允许大型语言模型（LLM）查看数据库架构并执行只读查询。下面将详细介绍其使用方法。
✨ 主要特性
- 认证支持：通过数据库 URL 支持 MySQL 认证，确保安全访问数据库。
- 工具功能：提供
query工具，可执行只读 SQL 查询，自动处理身份验证。 - 资源信息：为每个表提供数据库架构信息，包括列名和数据类型。
- Cursor 集成：支持在 Cursor 中配置和使用，方便与数据库进行交互。
📦 安装指南
- 克隆仓库：
git clone https://github.com/yourusername/mysql-mcp-server.git cd mysql-mcp-server - 准备并安装依赖项：
npm run prepare npm install - 创建全局链接：
npm link
安装完成后，您可以在终端的任何位置使用 mysql-mcp-server 命令：
mysql-mcp-server mysql://user:password@localhost:3306/mydb
💻 使用示例
在 Cursor 中配置 MCP
- 打开 Cursor 的设置：
- 点击底部左下角的齿轮图标（⚙️）；
- 或者按
Shift + Cmd + J（在 macOS 上）。
- 配置 MCP 服务器：
- 点击左侧边栏中的“MCP”；
- 点击“添加全局 MCP 服务器”；
- 添加以下配置：
{
"mcpServers": {
"mysql": {
"command": "mysql-mcp-server",
"args": ["mysql://user:password@localhost:3306/mydb"]
}
}
}
- 保存配置：
- 点击“保存”或按
Cmd + S； - 重启 Cursor 以使更改生效。
- 点击“保存”或按
如何在 Cursor 中使用它？
在 Cursor 中的智能聊天窗口打开，并开始与数据库相关的问题提问，它将拥有所有上下文。
安全最佳实践
⚠️ 重要提示
- 使用环境变量保存敏感凭证，示例配置如下：
{
"mcpServers": {
"mysql": {
"command": "mysql-mcp-server",
"args": ["mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@host:3306/mydb"]
}
}
}
- 确保 MySQL 用户具有最小的必需权限（只读访问）。
- 使用强密码并遵循安全最佳实践。
- 避免将包含凭证的配置文件提交到版本控制系统。
🔧 技术细节
认证
该服务器通过数据库 URL 支持 MySQL 认证。URL 格式如下：
mysql://用户名:密码@主机:端口/数据库
示例：
- 数据库：
mysql://user:pass@localhost:3306/mydb
组件
工具
- query
- 执行只读 SQL 查询针对连接的数据库。
- 输入：
sql（字符串）：要执行的 SQL 查询。 - 所有查询都在一个只读事务中执行。
- 使用提供的凭证自动处理身份验证。
资源
服务器为每个表提供数据库架构信息：
- 表格架构（
mysql:/// /schema）
- 每个表的 JSON 架构信息。
- 包括列名和数据类型。
- 自动从数据库元数据中发现。
- 使用提供的凭证进行身份验证访问。
📄 许可证
此 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由使用、修改和分发软件，但需遵守 MIT 许可证的条款和条件。有关详细信息，请参阅项目仓库中的 LICENSE 文件。