MySQL MCP Server

本项目是将 Python 代码库转换为 Java 的成果，源自 design-computer/mysql_mcp_server。 它保留了原始 Python 实现的核心功能和逻辑，可无缝集成到基于 Java 的环境中。

本项目是一个学习练习，用于探索 MCP（Model Context Protocol）概念。

欢迎社区提出建议、贡献代码或提供任何帮助，以进一步改进本项目。

要查看 io.modelcontextprotocol.sdk:mcp-bom 的 0.7 版和 0.8 版之间的代码差异，
请比较之前的提交和对应的提交。

MySQL MCP 服务

一个可与 MySQL 数据库安全交互的 Model Context Protocol（MCP）服务。该服务允许 AI 助手通过受控接口列出表、读取数据并执行 SQL 查询，让数据库探索和分析更加安全、结构化。

功能

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

安装

pip install mysql-mcp-server

配置

设置以下环境变量：

MYSQL_HOST=localhost     # Database host
MYSQL_PORT=3306         # Optional: Database port (defaults to 3306 if not specified)
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"
      }
    }
  }
}

作为独立服务运行

• 设置数据库配置
• 运行 Main Application

安全注意事项

• 切勿提交环境变量或凭据
• 使用仅具有所需最低权限的数据库用户
• 考虑在生产环境中实施查询白名单
• 监控并记录所有数据库操作

安全最佳实践

此 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