Demo Server

MySQL MCP Server

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

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

功能

• 将可用的 MySQL 表格列为资源
• 读取表格内容
• 执行 SQL 查询并进行适当的错误处理
• 通过环境变量安全地访问数据库
• 全面的日志记录

安装

手动安装

pip install mysql-mcp-server

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 MySQL MCP Server：

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

配置

设置以下环境变量：

MYSQL_HOST=localhost     # 数据库主机
MYSQL_PORT=3306         # 可选：数据库端口（如果未指定，则默认为 3306）
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

用法

与 Claude Desktop 一起使用

将其添加到您的 claude_desktop_config.json 中：

{
  "mcpServers": {
    "mysql": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/mysql_mcp_server",
        "run",
        "mysql_mcp_server"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "your_username",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

使用 MCP Inspector 调试

虽然 MySQL MCP Server 并非旨在独立运行或直接从命令行使用 Python 运行，但您可以使用 MCP Inspector 对其进行调试。

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

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

MySQL MCP Server 旨在与 AI 应用程序（如 Claude Desktop）集成，不应直接作为独立的 Python 程序运行。

开发

# 克隆存储库
git clone https://github.com/yourusername/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 实现需要数据库访问才能运行。为了安全起见：

1. 创建一个具有最小权限的专用 MySQL 用户
2. 永远不要使用 root 凭据或管理帐户
3. 将数据库访问限制为仅必要的操作
4. 启用日志记录以进行审计
5. 定期安全审查数据库访问

有关详细说明，请参阅 MySQL 安全配置指南，内容包括：

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

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

许可证

MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。

贡献

1. Fork 存储库
2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 将分支推送到远程仓库 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request