JinDaGe - mysql-mcp MCP Details

article

README

🚀 SQL MCP 服务器用于 Claude 桌面

本项目通过 Claude 桌面对本地 MySQL 数据库提供自然语言接口。借助此 MCP（机器通信协议）服务器，Claude 能够在本地 MySQL 数据库上执行 SQL 查询，让用户可以使用自然语言与数据库进行交互。

✨ 主要特性

自然语言转换：通过 Claude 将自然语言转换为 SQL 查询。
安全连接：可安全连接到本地 MySQL 数据库。
多数据库支持：支持多个数据库。
事务管理：确保数据一致性。
连接池优化：提高性能。
全类型查询支持：支持所有类型的 SQL 查询（如 SELECT、INSERT、UPDATE、DELETE 等）。

📦 安装指南

先决条件

Python 3.8 或更高版本
已安装并运行的 MySQL 服务器
Claude 桌面应用程序
虚拟环境（推荐）

安装步骤

克隆存储库

git clone git@github.com:meanands/mysql-mcp.git
cd mysql-mcp

创建并激活虚拟环境

# 适用于 macOS/Linux
python -m venv venv
source venv/bin/activate

# 适用于 Windows
python -m venv venv
venv\Scripts\activate

安装依赖项

pip install -r requirements.txt

创建 .env 文件 在项目根目录中创建 .env 文件，其中包含您的 MySQL 凭据：

MYSQL_HOST=localhost
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password

更新 run.sh 中的目录路径

# 打开 run.sh 并替换此行：
cd /Users/yourname/code/sql-mcp
# 例如，用您实际的项目目录路径替换：
cd /Users/yourname/projects/mysql-mcp

使运行脚本具有可执行性

chmod +x run.sh

💻 使用示例

在 Claude 桌面中的配置

打开 Claude 桌面的 MCP 配置。
添加以下配置：

{
  "sql": {
    "command": "/absolute/path/to/your/mysql-mcp/run.sh"
  }
}

请将 /absolute/path/to/your/mysql-mcp 替换为您的实际项目目录路径。

通过自然语言与数据库交互

配置完成后，您可以通过 Claude 桌面使用自然语言与数据库交互。示例如下：

选择数据库并创建表

使用 'employees' 数据库并创建一个存储员工信息的表，字段包括姓名、电子邮件和部门。

插入数据

插入一名新员工 John Doe，其电子邮件为 john.doe@example.com，在工程部工作。

查询数据

显示所有在工程部工作的员工。

📚 详细文档

重要注意事项

在 run.sh 脚本和 Claude 桌面配置中始终使用绝对路径。
确保 MySQL 服务器正在运行。
将 .env 文件保持安全，切勿将其提交到版本控制系统。
MCP 服务器使用连接池，默认连接数为 5。

故障排除

“拒绝连接”错误：如果您收到“拒绝连接”错误，请确保 MySQL 服务器正在运行。
身份验证错误：如果您收到身份验证错误，请检查 .env 文件中的凭据。
权限错误：对于权限错误，请确保您的 MySQL 用户具有执行尝试的操作的适当权限。

安全注意事项

将敏感凭证存储在 .env 文件中。
使用具有适当权限的 MySQL 用户（避免使用 root）。
保持虚拟环境和依赖项最新。
考虑访问非 localhost MySQL 服务器时的网络安全性。

mysql-mcp