内容
# MySQL MCP 服务器
本项目是一个为 AI 模型提供 MCP（模型上下文协议）服务器的 MySQL 数据库，允许执行 SQL 查询。
## 功能描述
服务器提供了一个工具，可以向 MySQL 数据库发送单个 SQL 语句，并将结果以 JSON 格式返回。同时，它还处理连接和执行错误。
## 要求
- Node.js
- npm、pnpm（推荐）或任何兼容的 Node.js 包管理器
## 安装
使用以下命令安装依赖：
```bash
npm install
```
或：
```bash
pnpm install
```
如果您使用 pnpm。
或适用于您的 Node.js 包管理器的等效命令。
## 配置
在运行服务器之前，请编辑“main.js”文件，并更新以下默认连接值以匹配您的 MySQL 配置：
```javascript
const DEFAULT_DB_HOST = "localhost";
const DEFAULT_DB_USER = "root";
const DEFAULT_DB_PASSWORD = "123456";
const DEFAULT_DB_NAME = "test";
```
用您的环境所需的数值替换这些值。在与 AI 对话时，请确保至少告诉它数据库名称和 SQL 语句。数据库必须已经存在。您也可以告诉它数据库主机、用户名和密码，但建议将这些值设置为上述常量中。
## 与 MCP 客户端一起使用
此服务器旨在由兼容 MCP 的客户端启动；您不需要手动运行 `node main.js`。配置正确的客户端将在需要时启动服务器。下面是示例客户端配置（将 `/path/to/...` 替换为系统上的正确路径）。
- Continue（VSCode 扩展）— 示例 `config.yaml`：
```yaml
mcpServers:
- name: MySQL MCP 服务器
command: npx
args:
- -y
- node
- /path/to/mcp_servers/mysql/main.js
env: {}
```
- Claude（桌面版）— 示例 `claude_desktop_config.json`：
```json
{
"mcpServers": {
"mysql": {
"command": "npx",
"args": ["-y", "node", "/path/to/mcp_servers/mysql/main.js"]
}
}
}
```
- GitHub Copilot（VSCode）。按 Ctrl+Shift+P（Windows 或 Linux）或 Cmd+Shift+P（Mac）打开命令面板。执行 MCP: Open User Configuration 命令。这会在全局用户配置文件目录中创建一个干净的 mcp.json。编辑 mcp.json 文件并放置以下内容：
```json
{
"servers": {
"mysql": {
"command": "npx",
"args": ["-y", "node", "/path/to/mcp_servers/mysql/main.js"]
}
}
}
```
- 通用 MCP 客户端（命令行）：
```bash
# 客户端可以这样启动服务器，如果必须手动启动
npx -y node /path/to/mcp_servers/mysql/main.js
```
注意：
- 请查看您使用的 MCP 客户端的文档以获取确切的配置键名；上述示例是通用模板。
