Mysql MCP Server

🚀 @davewind/mysql-mcp-server

这是一个提供只读访问 MySQL 数据库的模型上下文协议（Model Context Protocol）服务器。借助该服务器，大型语言模型（LLMs）能够查看数据库架构并执行只读查询，为数据交互提供了便捷且安全的途径。

✨ 主要特性

1. 只读数据库访问：借助 SQL 验证和 READ ONLY 事务，严格强制执行只读操作，保障数据安全。
2. 模式发现：可自动识别并暴露数据库表结构，方便用户了解数据库的组织形式。
3. SQL 查询执行：提供专门的查询工具，能够接受并执行 SELECT 语句，满足数据查询需求。
4. 模型上下文协议合规性：实现 MCP 规范，可与兼容的 LLM 实现无缝集成，提升系统间的协作效率。
5. 简单配置：易于设置，所需配置极少，降低了使用门槛。

🛠️ 工具

• query
  • 执行只读 SQL 查询以访问连接的数据库。
  • 输入: sql (字符串): 要执行的 SQL 查询。
  • 所有查询均在 READ ONLY 事务中执行，确保数据的安全性。

📚 资源

该服务器提供每个表的架构信息：

• 表格架构 (mysql://user:password@localhost:port/database)
  • 提供每个表的 JSON 架构信息。
  • 包含列名和数据类型。
  • 自动从数据库元数据中发现，方便用户获取数据库的详细结构。

📦 安装

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/ 并运行 npm run inspector。

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

🖥️ 环境要求

Node.js v18 +

🔧 技术细节

系统架构

MySQL MCP 服务器作为中介，介于 LLM 和 MySQL 数据库之间，根据 MCP 协议处理请求，实现了系统间的高效交互。

组件交互

暂未提供相关组件交互的详细内容。

安全模型

MySQL MCP 服务器实现了一个严格的安全模型，以确保数据库访问为只读。具体安全措施包括：

1. SQL 查询验证，仅允许 SELECT 语句，防止非法的数据修改操作。
2. 所有查询均在 READ ONLY 事务中执行，进一步保障数据的安全性。
3. 不支持数据修改操作（INSERT, UPDATE, DELETE 等），避免数据被意外修改。
4. 不支持数据库架构修改（CREATE, ALTER, DROP 等），确保数据库结构的稳定性。

🔌 集成与 LLMs

MySQL MCP 服务器设计用于与任何支持模型上下文协议的 LLM 系统一起使用。它通过 JSON - RPC over stdio 按照 MCP 规范进行通信，实现了与 LLM 系统的无缝集成。

📄 许可证

本项目采用 MIT 许可证。