PyPI - 下载量

MySQL MCP服务器

这是一个实现了模型上下文协议（MCP）的组件，能够安全地与MySQL数据库进行交互。该服务器组件促进了AI应用程序（主机/客户端）与MySQL数据库之间的通信，通过受控接口使数据库探索和分析更加安全、结构化。

注意：MySQL MCP服务器并非设计为独立运行的服务器，而是作为AI应用程序与MySQL数据库之间的通信协议实现。

功能特性

将可用的MySQL表作为资源列出
读取表内容
执行SQL查询并具备完善的错误处理机制
通过环境变量实现安全的数据库访问
全面的日志记录功能

安装方式

手动安装

pip install mysql-mcp-server

通过Smithery安装

要自动为Claude Desktop安装MySQL MCP服务器，请通过Smithery：

npx -y @smithery/cli install mysql-mcp-server --client claude

配置要求

设置以下环境变量：

MYSQL_HOST=localhost     # 数据库主机地址
MYSQL_PORT=3306         # 可选：数据库端口（未指定时默认为3306）
MYSQL_USER=你的用户名
MYSQL_PASSWORD=你的密码
MYSQL_DATABASE=你的数据库名

使用方法

在Claude Desktop中使用

将以下配置添加到claude_desktop_config.json：

{
  "mcpServers": {
    "mysql": {
      "command": "uv",
      "args": [
        "--directory", 
        "mysql_mcp_server的路径",
        "run",
        "mysql_mcp_server"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "你的用户名",
        "MYSQL_PASSWORD": "你的密码",
        "MYSQL_DATABASE": "你的数据库名"
      }
    }
  }
}

在Visual Studio Code中使用

将以下配置添加到mcp.json：

{
  "servers": {
      "mysql": {
            "type": "stdio",
            "command": "uvx",
            "args": [
                "--from",
                "mysql-mcp-server",
                "mysql_mcp_server"
            ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "你的用户名",
        "MYSQL_PASSWORD": "你的密码",
        "MYSQL_DATABASE": "你的数据库名"
      }
  }
}

注意：需要先安装uv才能正常工作

使用MCP Inspector调试

虽然MySQL MCP服务器不打算作为独立程序或直接通过Python命令行运行，但您可以使用MCP Inspector进行调试。

MCP Inspector提供了一种便捷的方式来测试和调试您的MCP实现：

# 安装依赖项
pip install -r requirements.txt
# 使用MCP Inspector进行调试（不要直接用Python运行）

MySQL MCP服务器设计为与Claude Desktop等AI应用程序集成，不应作为独立的Python程序直接运行。

开发指南

# 克隆代码仓库
git clone https://github.com/你的用户名/mysql_mcp_server.git
cd mysql_mcp_server
# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # Windows系统使用 `venv\Scripts\activate`
# 安装开发依赖
pip install -r requirements-dev.txt
# 运行测试
pytest

安全注意事项

切勿提交环境变量或凭证信息
使用具有最小必要权限的数据库用户
生产环境中考虑实施查询白名单
监控并记录所有数据库操作

安全最佳实践

此MCP实现需要数据库访问权限才能运行。出于安全考虑：

创建专用的MySQL用户并设置最小权限
切勿使用root凭证或管理员账户
限制数据库访问仅执行必要操作
启用日志记录以便审计
定期审查数据库访问的安全性

详细的安全配置说明请参阅MySQL安全配置指南：

创建受限的MySQL用户
设置适当的权限
监控数据库访问
安全最佳实践

⚠️ 重要提示：配置数据库访问时始终遵循最小权限原则。

许可证

MIT许可证 - 详情请参阅LICENSE文件。

贡献指南

分叉代码仓库
创建功能分支（git checkout -b feature/精彩功能）
提交更改（git commit -m '添加某个精彩功能'）
推送到分支（git push origin feature/精彩功能）
创建Pull Request