MySQL只读查询服务

MySQL MCP Server是一个提供MySQL数据库只读访问的协议服务器,允许LLMs检查数据库模式并执行只读查询。

  • by shreyansh-ghl
  • JavaScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 shreyansh-ghl/mysql-mcp-server

使用说明

MySQL MCP服务器

一种模型上下文协议服务器,提供对MySQL数据库的只读访问。此服务器使LLM能够检查数据库模式并执行只读查询。

认证

服务器支持通过数据库URL进行MySQL身份验证。URL格式为:

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

示例:

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

备注:始终确保您的凭据得到适当保护,不会在公共配置中暴露。

组件

工具

  • 怎么翻译
    • 对连接的数据库执行只读SQL查询
    • 输入: sql (string):要执行的SQL查询
    • 所有查询都在只读事务中执行
    • 使用提供的凭据自动处理身份验证

资源

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

  • 持微软签名的表模式 (mysql://<host>/<table>/schema)
    • 每个表的JSON模式信息
    • 包括列名和数据类型
    • 从数据库元数据中自动发现
    • 使用提供的凭据对访问进行身份验证

安装

  1. 克隆存储库:
git clone https://github.com/yourusername/mysql-mcp-server.git
cd mysql-mcp-server
  1. 准备并安装依赖项:
npm run prepare
npm install
  1. 创建全局链接:
npm link

现在,您可以使用 mysql-mcp-server 从终端中的任何位置执行命令:

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

使用游标

在游标中配置MCP

  1. 打开Cursor的设置:

    • 点击齿轮图标(⚙️) 光标左下角
    • 或按 Shift + Cmd + J 在 macOS 上
  2. 配置MCP服务器:

    • 点击左侧边栏中的“MCP”
    • 点击“添加全局MCP服务器”
    • 添加以下配置:
{
  "mcpServers": {
    "mysql": {
      "command": "mysql-mcp-server",
      "args": ["mysql://user:password@localhost:3306/mydb"]
    }
  }
}
  1. 保存配置:
    • 点击“保存”或按 Cmd + S
    • 重新启动Cursor以使更改生效

如何在Cursor上使用它?

打开Cursor上的代理聊天,开始询问与我们的数据库相关的问题,它将包含所有上下文

安全最佳实践

  1. 对敏感凭据使用环境变量:

    {
      "mcpServers": {
        "mysql": {
          "command": "mysql-mcp-server",
          "args": ["mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@host:3306/mydb"]
        }
      }
    }
    
  2. 确保MySQL用户具有所需的最小权限(只读访问)

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

  4. 避免将带有凭据的配置文件提交到版本控制

许可证

此MCP服务器根据MIT许可证获得许可。这意味着您可以根据MIT许可证的条款和条件自由使用、修改和分发软件。有关更多详细信息,请参阅项目存储库中的LICENSE文件。