MySQL MCP Server

MySQL MCP Server

site icon
2025.03.26 1
JavaScript数据库访问只读查询模式检查数据库
MySQL MCP Server 是一个基于 Model Context Protocol 的服务,提供对 MySQL 数据库的只读访问。该服务允许 LLMs(大型语言模型)检查数据库模式并执行只读查询。
View on GitHub

Overview

基本能力

产品定位

MySQL MCP Server 是一个数据库访问工具,专注于提供对 MySQL 数据库的只读访问,适用于需要数据库查询和模式检查的场景。

核心功能

  1. 只读查询:支持执行只读 SQL 查询。
  2. 模式检查:提供数据库表的 JSON 模式信息,包括列名和数据类型。
  3. 自动认证:通过数据库 URL 自动处理认证。

适用场景

  1. 数据库查询:适用于需要执行只读查询的场景。
  2. 模式检查:适用于需要检查数据库模式的场景。
  3. LLM 集成:适用于需要将数据库访问集成到 LLMs 中的场景。

工具列表

  1. query
  2. 功能:对连接的数据库执行只读 SQL 查询。
  3. 输入:sql(字符串):要执行的 SQL 查询。
  4. 所有查询都在只读事务中执行。
  5. 认证使用提供的凭据自动处理。

常见问题解答

  1. 如何保护敏感凭据?
  2. 使用环境变量存储敏感凭据。
  3. 避免将包含凭据的配置文件提交到版本控制。
  4. 如何确保安全?
  5. 使用强密码并遵循安全最佳实践。
  6. 确保 MySQL 用户具有最小所需权限(只读访问)。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 克隆仓库并安装依赖: sh git clone https://github.com/yourusername/mysql-mcp-server.git cd mysql-mcp-server npm run prepare npm install

安装教程

  1. 创建全局链接: sh npm link
  2. 使用 mysql-mcp-server 命令: sh mysql-mcp-server mysql://user:password@localhost:3306/mydb

调试方式

  1. 配置 MCP 服务器:
  2. 打开 Cursor 的设置。
  3. 在 MCP 部分添加全局 MCP 服务器配置: json { "mcpServers": { "mysql": { "command": "mysql-mcp-server", "args": ["mysql://user:password@localhost:3306/mydb"] } } }
  4. 保存配置并重启 Cursor。
  5. 在 Agentic 聊天中开始提问与数据库相关的问题。

许可证

该项目遵循 MIT 开源许可条款。