MySQL MCP 服务器文档

概述

这是一个生产就绪的 MySQL MCP（模型上下文协议）服务器，通过 MCP 工具提供安全的数据库访问。该服务器包括身份验证、监控以及全面的数据库操作。

快速开始

先决条件

• Python 3.8+
• MySQL 数据库服务器
• Claude 桌面应用程序
• Git

安装

1. 克隆并导航到项目：

cd C:\Users\MCP-Procuction_MySQL

2. 安装依赖项：

pip install -r requirements.txt

3. 设置环境变量（创建 .env 文件）：

# 数据库配置
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

# 安全性
SECRET_KEY=your-secret-key-here
ALLOWED_OPERATIONS=SELECT,INSERT,UPDATE,DELETE

# 可选：GitHub OAuth
GITHUB_CLIENT_ID=your_github_client_id
GITHUB_CLIENT_SECRET=your_github_client_secret

# 可选：监控
SENTRY_DSN=your_sentry_dsn

运行服务器

主要方法：

python -m src.main

替代方法：

# 使用运行脚本
python run_server.py

# 单独模式
python mcp_standalone.py

Claude 桌面集成

Claude 桌面 MCP 配置

在您的 Claude 桌面 MCP 设置文件中添加此配置。配置文件通常位于：

Windows: %APPDATA%\Claude\claude_desktop_config.json macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Linux: ~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "mysql-mcp": {
      "command": "python",
      "args": ["src/server.py"],
      "cwd": "/path/to/your/MYSQL-Production"
    }
  }
}

Claude 桌面设置步骤

1. 安装 MCP 服务器（遵循上述安装步骤）
2. 找到您的 Claude 桌面配置文件使用上述路径
3. 向配置文件添加 MCP 配置
4. 更新 cwd 路径以匹配您的实际安装目录
5. 在项目目录中的 .env 文件中设置环境变量
6. 重启 Claude 桌面以加载新的 MCP 服务器
7. 通过要求 Claude 列出数据库表来验证连接

配置说明

• 将 your_username、your_password 等替换为您实际的数据库凭据
• 更新 cwd 路径以匹配您的实际安装目录
• 确保系统 PATH 中有可用的 Python
• 服务器将在 Claude 桌面中作为 "mysql-mcp" 可用

测试 Claude 集成

配置完成后，您可以通过要求 Claude 来测试集成：

• "列出我数据库中的所有表"
• "显示用户表的结构"
• "查询我的产品表中的前五行"

项目结构

MYSQL-Production/
├── src/
│   ├── main.py              # 主 MCP 服务器入口点
│   ├── server.py            # 核心 MCP 服务器实现
│   ├── config.py            # 配置管理
│   ├── models.py            # 数据模型
│   ├── auth/                # 身份验证模块
│   │   ├── github_oauth.py  # GitHub OAuth 集成
│   │   └── session.py       # 会话管理
│   ├── database/            # 数据库模块
│   │   ├── connection.py    # 数据库连接处理
│   │   ├── security.py      # 安全性和验证
│   │   └── utils.py         # 数据库工具
│   ├── tools/               # MCP 工具实现
│   │   ├── basic_tools.py   # 基本数据库操作
│   │   ├── advanced_tools.py# 高级数据库功能
│   │   ├── write_tools.py   # 写操作
│   │   └── transaction_tools.py # 事务管理
│   └── monitoring/          # 监控和日志
│       └── sentry.py        # Sentry 集成
├── tests/                   # 测试套件
├── requirements.txt         # Python 依赖项
├── pyproject.toml          # 项目配置
├── docker-compose.yml      # Docker 设置
└── README.md               # 基础文档

可用的 MCP 工具

基本操作

• mysql-mcp:query_database - 执行 SELECT 查询
• mysql-mcp:list_tables - 列出所有数据库表
• mysql-mcp:describe_table - 获取表结构信息

写操作

• mysql-mcp:execute_sql - 执行 INSERT、UPDATE、DELETE 操作
• mysql-mcp:create_table - 创建新表

高级功能

• 事务管理
• 查询优化
• 性能监控
• 安全验证

配置

环境变量

变量	描述	是否必需	默认值
MYSQL_HOST	MySQL 服务器主机	是	localhost
MYSQL_PORT	MySQL 服务器端口	否	3306
MYSQL_USER	数据库用户名	是	-
MYSQL_PASSWORD	数据库密码	是	-
MYSQL_DATABASE	数据库名称	是	-
SECRET_KEY	安全密钥	是	-
ALLOWED_OPERATIONS	允许的 SQL 操作	否	SELECT,INSERT,UPDATE,DELETE
MAX_CONNECTIONS	连接池大小	否	1[...]

user

请继续完成剩余部分的翻译。