MySQL MCP Server

MySQL MCP 服务

一个提供 MySQL 数据库只读访问权限的 Model Context Protocol 服务。此服务可让大模型检查数据库架构并执行只读查询。

身份验证

此服务通过数据库 URL 进行 MySQL 身份验证。URL 格式如下：

mysql://username:password@host:port/database

示例：

• DB：mysql://user:pass@localhost:3306/mydb

注意：请始终确保凭据得到妥善保护，不会在公开配置中暴露。

组件

工具

• query
  • 对已连接的数据库执行只读 SQL 查询
  • 输入：sql（字符串）：要执行的 SQL 查询
  • 所有查询都在 READ ONLY 事务中执行
  • 使用提供的凭据自动进行身份验证

资源

此服务为数据库中的每个表提供架构信息：

• 表架构（mysql://<host>/<table>/schema）
  • 每个表的 JSON 架构信息
  • 包含列名和数据类型
  • 根据数据库元数据自动发现
  • 使用提供的凭据进行身份验证后访问

安装

1. 克隆仓库：

git clone https://github.com/yourusername/mysql-mcp-server.git
cd mysql-mcp-server

2. 准备并安装依赖项：

npm run prepare
npm install

3. 创建全局链接：

npm link

现在，你可以在终端的任意位置使用 mysql-mcp-server 命令：

mysql-mcp-server mysql://user:password@localhost:3306/mydb

在 Cursor 中使用

在 Cursor 中配置 MCP

1. 打开 Cursor 的设置：

   • 点击 Cursor 左下角的齿轮图标（⚙️）
   • 或在 macOS 上按下 Shift + Cmd + J

2. 配置 MCP 服务：

   • 点击左侧边栏中的 “MCP”
   • 点击 “Add Global MCP Server”
   • 添加以下配置：

{
  "mcpServers": {
    "mysql": {
      "command": "mysql-mcp-server",
      "args": ["mysql://user:password@localhost:3306/mydb"]
    }
  }
}

3. 保存配置：
   • 点击 “Save” 或按下 Cmd + S
   • 重启 Cursor 以使更改生效

如何在 Cursor 中使用？

打开 Cursor 中的 Agentic 聊天，并开始提问与我们的数据库相关的问题，它就能获取所有上下文

安全最佳实践

1. 使用环境变量存储敏感凭据：

   {
     "mcpServers": {
       "mysql": {
         "command": "mysql-mcp-server",
         "args": ["mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@host:3306/mydb"]
       }
     }
   }
   

2. 确保 MySQL 用户仅拥有所需的最低权限（只读访问权限）

3. 使用强密码并遵循安全最佳实践

4. 避免将包含凭据的配置文件提交到版本控制系统

许可证

此 MCP 服务采用 MIT License 许可。这意味着你可以自由使用、修改和分发此软件，但须遵守 MIT License 的条款和条件。有关详情，请参阅项目仓库中的 LICENSE 文件。