@davewind/mysql-mcp-server

@davewind/mysql-mcp-server

site icon
2025.04.27 6
JavaScript数据库中间件只读访问数据库
mysql-mcp-server 是一个遵循 Model Context Protocol 的服务,提供对 MySQL 数据库的只读访问。该服务允许 LLMs(大型语言模型)检查数据库结构并执行只读查询。
View on GitHub

Overview

基本能力

产品定位

mysql-mcp-server 是一个数据库中间件,专门为 LLMs 提供对 MySQL 数据库的只读访问能力。

核心功能

  1. 只读数据库访问:通过 SQL 验证和 READ ONLY 事务强制执行只读操作。
  2. 模式发现:自动识别并暴露数据库表结构。
  3. SQL 查询执行:提供查询工具,接受并执行 SELECT 语句。
  4. Model Context Protocol 合规性:实现 MCP 规范,与兼容的 LLMs 无缝集成。
  5. 简单配置:设置简单,所需配置最少。

适用场景

  • LLMs 需要查询 MySQL 数据库的场景。
  • 需要自动发现数据库表结构的场景。
  • 需要确保数据库访问为只读的安全场景。

工具列表

  • query
  • 对连接的数据库执行只读 SQL 查询。
  • 输入:sql(字符串):要执行的 SQL 查询。
  • 所有查询都在 READ ONLY 事务中执行。

常见问题解答

  • 如何确保数据库访问是只读的?
  • 通过 SQL 查询验证,仅允许 SELECT 语句。
  • 所有查询都在 READ ONLY 事务中执行。
  • 不支持数据修改操作(INSERT、UPDATE、DELETE 等)。
  • 不支持数据库模式修改(CREATE、ALTER、DROP 等)。

使用教程

使用依赖

  • Node.js v18 或更高版本。

安装教程

npm install @davewind/mysql-mcp-server -g

配置

MCP 设置配置文件:

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@davewind/mysql-mcp-server", "mysql://user:password@localhost:port/database"]
    }
  }
}

调试方式

替换 mysql://user:password@localhost:port/ 并运行:

"scripts": {
  "inspector": "npx @modelcontextprotocol/[email protected] build/index.js mysql://user:password@localhost:port/database"
}

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。