用于 Claude Desktop 的 SQL MCP 服务器

一个通过 Claude Desktop 连接本地 MySQL 数据库的自然语言接口。 这个 MCP (机器通信协议) 服务器允许 Claude 在你的本地 MySQL 数据库上执行 SQL 查询，使你能够使用自然语言与你的数据库进行交互。

功能特性

• 通过 Claude 将自然语言转换为 SQL 查询
• 安全连接到本地 MySQL 数据库
• 支持多个数据库
• 事务管理，保证数据一致性
• 连接池，提高性能
• 支持所有类型的 SQL 查询 (SELECT, INSERT, UPDATE, DELETE 等)

前提条件

• Python 3.8 或更高版本
• 已安装并运行的 MySQL 服务器
• Claude Desktop 应用程序
• 虚拟环境 (推荐)

安装

1. 克隆此仓库:

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

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

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

# 对于 Windows
python -m venv venv
venv\Scripts\activate

3. 安装依赖:

pip install -r requirements.txt

4. 在项目根目录下创建一个 .env 文件，并填写你的 MySQL 凭据:

MYSQL_HOST=localhost
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password

5. 更新 run.sh 中的目录路径:

# 打开 run.sh 并替换这一行:
cd /Users/yourname/code/sql-mcp
# 为你的实际项目目录路径，例如:
cd /Users/yourname/projects/mysql-mcp

6. 使运行脚本可执行:

chmod +x run.sh

在 Claude Desktop 中配置

1. 打开 Claude Desktop 的 MCP 配置
2. 添加以下配置:

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

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

使用方法

配置完成后，你可以通过 Claude Desktop 使用自然语言与你的数据库进行交互。 示例:

1. 选择一个数据库并创建一个表:

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

2. 插入数据:

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

3. 查询数据:

显示工程部门的所有员工。

重要提示

• 始终在 run.sh 脚本和 Claude Desktop 配置中使用绝对路径
• 确保 MySQL 服务器在使用 MCP 服务器之前正在运行
• 确保你的 .env 文件安全，并且永远不要将其提交到版本控制
• MCP 服务器使用连接池，默认池大小为 5 个连接

故障排除

1. 如果你收到 "connection refused" 错误，请确保你的 MySQL 服务器正在运行
2. 如果你收到身份验证错误，请验证你的 .env 文件中的凭据
3. 对于权限错误，请确保你的 MySQL 用户具有执行你尝试执行的操作的适当权限

安全注意事项

• 将敏感凭据存储在 .env 文件中
• 使用具有适当权限的 MySQL 用户 (避免使用 root)
• 保持你的虚拟环境和依赖项为最新
• 如果访问非 localhost MySQL 服务器，请考虑网络安全