MySQL数据库连接工具

一个提供MySQL数据库连接和工具集成的Model Context Protocol (MCP)服务器。

  • by irwantocrimson
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 irwantocrimson/mysql-mcp

使用说明

MySQL MCP服务器

提供MySQL数据库连接和工具的模型上下文协议(MCP)服务器。

安装

npm install
npm run build

用法

配置

可以使用环境变量或命令行参数配置服务器。环境变量优先于命令行参数。

环境变量

  • MYSQL_HOST:MySQL主机(默认:localhost)
  • MYSQL_PORT:MySQL端口(默认:3306)
  • MYSQL_USER:MySQL用户(默认:root)
  • MYSQL_PASSWORD:MySQL密码(默认值:空)
  • MYSQL_DATABASE:MySQL数据库(默认:测试)

命令行参数

  • -h, --host:MySQL主机(默认:localhost)
  • -p, --port:MySQL端口(默认:3306)
  • -u, --user:MySQL用户(默认:root)
  • -P, --password:MySQL密码(默认值:空)
  • -d, --database:MySQL数据库(默认:测试)

例子

默认设置下的基本用法:

crimson-mysql-mcp

指定自定义主机和数据库:

crimson-mysql-mcp --host db.example.com --database myapp

使用短标志:

crimson-mysql-mcp -h 192.168.1.100 -u myuser -P mypass -d production

Claude桌面配置

使用环境变量(推荐):

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": [
        "-y",
        "crimson-mysql-mcp@1.0.2"
      ],
      "env": {
        "MYSQL_HOST": "your-mysql-host",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "your-username",
        "MYSQL_PASSWORD": "your-password",
        "MYSQL_DATABASE": "your-database"
      }
    }
  }
}

对于当地发展:

{
  "mcpServers": {
    "mysql": {
      "command": "node",
      "args": [
        "/path/to/your/crimson-mysql-mcp/build/index.js"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_USER": "root",
        "MYSQL_DATABASE": "test"
      }
    }
  }
}

可用工具

  • 获取模式:获取MySQL表的架构/结构
    • 参数: schemaName (string)-要描述的表的名称

发展

# Install dependencies
npm install

# Run in development mode
npm run server:dev

# Build the project
npm run build

# Watch and rebuild on changes
npm run server:build:watch

# Run with MCP Inspector (for debugging)
npm run server:inspect

发布到npm

要通过npx提供此软件包,请执行以下操作:

  1. 使用您的npm帐户详细信息更新package.json
  2. 运行:
    npm publish
    

许可证

国际学生委员会