JinDaGe - mysqldb-mcp-server MCP Details

article

README

🚀 MySQL数据库MCP服务器

本项目是一个MySQL数据库MCP服务器，能够为用户提供便捷的数据库连接与查询服务。

🚀 快速开始

安装

你可以使用以下两种方式安装该包：

使用uv：

uv pip install mysqldb-mcp-server

使用pip：

pip install mysqldb-mcp-server

配置服务器

服务器使用以下环境变量进行配置： | 属性 | 详情 | |------|------| | MYSQL_HOST | MySQL服务器地址（默认："localhost"） | | MYSQL_USER | MySQL用户名（默认："root"） | | MYSQL_PASSWORD | MySQL密码（默认：""） | | MYSQL_DATABASE | 初始数据库（可选） | | MYSQL_READONLY | 只读模式（设为1/true以启用，默认：false） |

不同系统下的配置文件路径

Claude Desktop

MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
Windows: %APPDATA%/Claude/claude_desktop_config.json

服务器配置示例

开发/未发布的服务器配置

{
  "mcpServers": {
    "mysqldb-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/burakdirin/Projects/mysqldb-mcp-server",
        "run",
        "mysqldb-mcp-server"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_USER": "root",
        "MYSQL_PASSWORD": "password",
        "MYSQL_DATABASE": "[optional]",
        "MYSQL_READONLY": "true"
      }
    }
  }
}

已发布的服务器配置

{
  "mcpServers": {
    "mysqldb-mcp-server": {
      "command": "uvx",
      "args": [
        // 此处原文未完整展示，保持原样
      ]
    }
  }
}

✨ 主要特性

工具

该服务器提供两个实用工具：

connect_database：用于连接到特定的MySQL数据库。
- database参数：要连接的数据库名称（字符串）
- 连接成功时返回确认消息
execute_query：执行MySQL查询。
- query参数：要执行的一个或多个SQL查询（字符串）
- 以JSON格式返回查询结果
- 多个查询可以通过分号分隔发送

📦 安装指南

你可以使用以下两种方式安装mysqldb-mcp-server包：

使用uv：

uv pip install mysqldb-mcp-server

使用pip：

pip install mysqldb-mcp-server

📚 详细文档

组件说明

工具

connect_database：此工具用于连接到指定的MySQL数据库。通过传入database参数（字符串类型，表示要连接的数据库名称），在连接成功后会返回确认消息。
execute_query：该工具用于执行MySQL查询。通过传入query参数（字符串类型，表示要执行的一个或多个SQL查询），查询结果将以JSON格式返回。多个查询可以通过分号分隔发送。

配置说明

服务器依赖以下环境变量进行配置：

MYSQL_HOST：指定MySQL服务器的地址，默认值为"localhost"。
MYSQL_USER：指定MySQL用户名，默认值为"root"。
MYSQL_PASSWORD：指定MySQL密码，默认值为空字符串。
MYSQL_DATABASE：指定初始数据库，该参数为可选。
MYSQL_READONLY：用于启用只读模式，将其设为1或true可启用，默认值为false。

快速开始说明

安装

介绍了使用uv和pip两种方式安装mysqldb-mcp-server包的命令。

配置文件路径

说明了在Claude Desktop的不同系统（MacOS和Windows）下的配置文件路径。

服务器配置

提供了开发/未发布和已发布两种情况下的服务器配置示例，包括命令、参数和环境变量的设置。

注意事项

请确保在使用服务器前正确配置环境变量，以保证服务器能够正常连接到MySQL数据库。同时，在执行execute_query工具时，要注意SQL查询语句的正确性和安全性。

参考链接

通过该链接可以获取更多关于该项目的信息。

mysqldb-mcp-server