# 🚀 快速开始指南
## 5分钟配置 MySQL MCP 服务器
### 方式一：Claude Desktop (推荐)
#### macOS/Linux 用户
```bash
# 1. 克隆并构建项目
git clone https://github.com/jway8975/mysql-readonly-mcp.git
cd mysql-readonly-mcp
npm install
npm run build
# 2. 运行自动配置脚本
chmod +x scripts/setup-claude-desktop.sh
./scripts/setup-claude-desktop.sh
# 3. 重启 Claude Desktop
```
#### Windows 用户
```cmd
# 1. 克隆并构建项目
git clone https://github.com/jway8975/mysql-readonly-mcp.git
cd mysql-readonly-mcp
npm install
npm run build
# 2. 运行自动配置脚本
scripts\setup-claude-desktop.bat
# 3. 重启 Claude Desktop
```
### 方式二：Claude Code
```bash
# 1. 克隆项目
git clone https://github.com/jway8975/mysql-readonly-mcp.git
cd mysql-readonly-mcp
# 2. 安装依赖
npm install
npm run build
# 3. 配置环境变量
export MYSQL_HOST="localhost"
export MYSQL_USER="your_username"
export MYSQL_PASSWORD="your_password"
export MYSQL_DATABASE="your_database"
# 4. 创建配置文件
cp .claude_config.example .claude_config
# 5. 开始使用
claude-code "帮我查看用户表的结构"
```
### 方式三：手动配置 Claude Desktop
1. **构建项目**：
```bash
npm run build
```
2. **找到配置文件**：
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
3. **添加配置**：
```json
{
"mcpServers": {
"mysql-readonly": {
"command": "node",
"args": ["/完整路径/mysql-readonly-mcp/dist/index.js"],
"env": {
"MYSQL_HOST": "localhost",
"MYSQL_USER": "your_username",
"MYSQL_PASSWORD": "your_password",
"MYSQL_DATABASE": "your_database"
}
}
}
}
```
4. **重启 Claude Desktop**
## 🧪 验证安装
在 Claude 中询问以下问题来测试连接：
```
列出数据库中的所有表
```
```
查看 users 表的结构
```
```
查询 users 表的前5条记录
```
## ❓ 常见问题
**Q: Claude 找不到 mysql_query 工具？**
A: 检查配置文件路径是否正确，确保使用绝对路径，并重启 Claude Desktop。
**Q: 连接数据库失败？**
A: 验证数据库凭据，确保 MySQL 服务运行，用户具有 SELECT 权限。
**Q: Windows 路径问题？**
A: 在 Windows 路径中使用双反斜杠，如 `C:\\Users\\username\\mysql-readonly-mcp\\dist\\index.js`
## 🔗 相关链接
- [完整文档](README.md)
- [故障排除](README.md#故障排除)
- [GitHub Issues](https://github.com/jway8975/mysql-readonly-mcp/issues)