MCP Server for MySQL based on NodeJS

MCP Server for MySQL based on NodeJS

site icon
2025.02.25 0
数据库访问MySQL 工具数据库
mcp-server-mysql 是一个基于 NodeJS 的 Model Context Protocol 服务器,提供对 MySQL 数据库的只读访问。该服务器使 LLMs 能够检查数据库模式并执行只读查询。
View on GitHub

Overview

基本能力

产品定位

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

核心功能

  • 提供对 MySQL 数据库的只读访问
  • 执行只读 SQL 查询
  • 自动发现数据库元数据并提供表结构信息

适用场景

  • LLMs 需要查询数据库信息时
  • 开发人员需要快速查看数据库结构时
  • 需要安全地提供数据库信息给第三方应用时

工具列表

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

资源

  • 表结构
  • 每个表的 JSON 模式信息
  • 包括列名和数据类型
  • 从数据库元数据自动发现

常见问题解答

  • 问题:"Could not connect to MCP server mcp-server-mysql"
  • 解决方案:需要明确设置所有必需二进制文件的路径,包括在配置中添加 PATH 环境变量

使用教程

使用依赖

  • NodeJS 环境
  • MySQL 数据库

安装教程

  1. 确保已安装 NodeJS 和 npm
  2. 通过 npx 直接运行:
npx -y @benborla29/mcp-server-mysql

配置示例

添加到 claude_desktop_config.json 的 "mcpServers" 部分:

{
  "mcpServers": {
    "mcp_server_mysql": {
      "command": "npx",
      "args": [
        "-y",
        "@benborla29/mcp-server-mysql"
      ],
      "env": {
        "MYSQL_HOST": "127.0.0.1",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "root",
        "MYSQL_PASS": "",
        "MYSQL_DB": "db_name"
      }
    }
  }
}

调试方式

  1. 检查 MySQL 连接参数是否正确
  2. 确保 PATH 环境变量包含必要的二进制文件路径
  3. 检查 NodeJS 和 npm 版本是否兼容

许可证

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