article
README
🚀 MySQL MCP 服务器
MySQL MCP 服务器是一个基于模型上下文协议(MCP)的服务器,它允许用户通过 MCP 协议执行 SQL 查询,为数据库操作提供了便捷的途径。
🚀 快速开始
本服务器允许通过 MCP 协议执行 SQL 查询,还能检查数据库连接状态,并且内置了 SQL 查询示例提示,方便用户使用。
✨ 主要特性
- 通过 MCP 协议执行 SQL 查询。
- 检查数据库连接状态。
- 内置 SQL 查询示例提示。
📦 安装指南
# 克隆仓库
git clone https://github.com/shengshengshengbuxi/mysql_mcp_server.git
cd mysql_mcp_server
# 安装依赖
npm install
# 编译 TypeScript 代码
npm run build
📚 详细文档
配置
服务器使用以下环境变量进行配置:
| 属性 | 详情 |
|------|------|
| MYSQL_HOST | MySQL 主机地址(默认: localhost) |
| MYSQL_PORT | MySQL 端口(默认: 3306) |
| MYSQL_USER | MySQL 用户名(默认: root) |
| MYSQL_PASSWORD | MySQL 密码(默认: 空) |
| MYSQL_DATABASE | MySQL 数据库名(默认: 空) |
运行
# 设置 MySQL 连接参数
$env:MYSQL_HOST = "localhost"
$env:MYSQL_PORT = "3306"
$env:MYSQL_USER = "root"
$env:MYSQL_PASSWORD = "your_password"
$env:MYSQL_DATABASE = "your_database"
# 启动服务器
npm start
与 Claude 集成
要在 Claude Desktop 中使用此服务器,请编辑 Claude Desktop 配置文件: Windows:
%USERPROFILE%\AppData\Roaming\Claude\claude_desktop_config.json
添加以下配置:
{
"mcpServers": {
"mysql": {
"command": "node",
"args": [
"/path/to/mysql_mcp_server/dist/server.js",
],
"env": {
"MYSQL_HOST": "localhost",
"MYSQL_PORT": "3306",
"MYSQL_USER": "root",
"MYSQL_PASSWORD": "your password",
"MYSQL_DATABASE": "your database"
}
}
}
}
工具
execute_sql: 执行 SQL 查询。check_connection: 检查数据库连接状态。
提示
sql_example: 提供 SQL 查询示例。
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫