MySQL MCP Server

MySQL MCP Server

本项目提供一个使用 MCP（Model Context Protocol）与 MySQL 数据库交互的服务。它提供了一个用于在 WSL 环境中访问 MySQL 数据库的接口。

功能

• 获取 MySQL 数据库中的表列表
• 从表中读取数据（最多 100 行）
• 执行 SQL 查询（SELECT、SHOW TABLES、INSERT、UPDATE、DELETE 等）

项目结构

src/mysql_mcp_server/
├── __init__.py        # パッケージ初期化
├── config/           # 設定関連モジュール
│   ├── __init__.py  
│   └── settings.py   # データベース設定
├── database/         # データベース操作モジュール
│   ├── __init__.py  
│   ├── connection.py # DB接続処理
│   └── errors.py     # エラークラス
├── tools/            # ツールモジュール
│   ├── __init__.py  
│   └── sql_tools.py  # SQL実行ツール
└── server.py         # MCPサーバーメイン

安装和运行

前提条件

• Python 3.11 或更高版本
• MySQL 服务（本地或远程）
• 虚拟环境（virtualenv）
• Docker（如需使用 Docker）

设置

1. 克隆仓库：

   git clone <repository-url>
   cd mysql_mcp_server
   

2. 创建并激活虚拟环境：

   python -m venv .venv
   source .venv/bin/activate  # Linuxの場合
   

3. 安装依赖：

   pip install -r requirements.txt .
   

4. 运行设置脚本，为运行脚本添加执行权限：

   chmod +x setup.sh
   ./setup.sh
   

运行方式

可以通过以下任一方式运行服务：

1. 直接运行

./run_direct.sh

2. 作为模块运行

./run_module.sh

3. 在 Docker 容器中运行

# Dockerイメージをビルド
docker build -t mysql-mcp-server:latest .

# コンテナを実行
./run_docker.sh

环境变量

服务使用以下环境变量连接 MySQL：

• MYSQL_HOST：MySQL 服务的主机（默认值：host.docker.internal）
• MYSQL_PORT：MySQL 服务的端口（默认值：13306）
• MYSQL_USER：MySQL 用户名
• MYSQL_PASSWORD：MySQL 密码
• MYSQL_DATABASE：要使用的数据库名称

MCP 协议

此服务实现了 MCP（Model Control Protocol），并提供以下端点：

• list_resources：获取数据库中的表列表
• read_resource：从指定表中读取数据
• list_tools：列出可用工具（用于执行 SQL 查询）
• call_tool：执行 SQL 查询

WSL 集成

连接 WSL（Windows Subsystem for Linux）环境中的 MySQL 服务时：

1. 确认 WSL 中的 MySQL 服务已启动
2. 确认 WSL 中的 MySQL 已配置为允许远程连接
   • 在 /etc/mysql/mysql.conf.d/mysqld.cnf 文件中将 bind-address 修改为 0.0.0.0
   • 为要使用的 MySQL 用户授予远程访问权限
3. 确认 Windows 侧的防火墙允许连接 MySQL 端口（默认值为 13306）

开发

Nox 会话

此项目提供用于测试、格式化和代码检查的 Nox 会话。

1. 安装 Nox：

   pip install nox
   

2. 运行所有测试：

   nox -s test
   

3. 格式化代码：

   nox -s format
   

4. 运行代码检查：

   nox -s lint
   

直接运行测试

pytest tests/

查看代码覆盖率

pytest --cov=src.mysql_mcp_server tests/

许可证

本项目根据 MIT 许可证发布。