# 怪兽框架开发者工具

**Repository Path**: dkgs/gs_developer

## Basic Information

- **Project Name**: 怪兽框架开发者工具
- **Description**: Thinkphp版本的可视化小程序、公众号开发工具，支持Claude code快捷开发，内置自定义命令
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.dkyx.cc/addons/gs_developer
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-09
- **Last Updated**: 2025-11-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gs_developer - 怪兽开发者工具插件

> 通过在线可视化设计器 + Claude Code AI 辅助，快速生成 ThinkPHP CRUD 代码

---

## ✨ 功能特性

### 核心能力

- 🎨 **可视化表设计器** - 拖拽式设计数据库表结构
- 🤖 **AI 智能操作** - Claude Code 直接操作数据库结构
- 🔄 **代码自动生成** - 一键生成 Controller/Model/Vue/API/Router
- 📊 **智能差异比对** - 自动识别新旧代码差异，避免覆盖自定义修改
- 📜 **历史版本管理** - 自动保存每次修改，支持回滚
- 🔌 **插件化架构** - 独立插件，易于集成和发布

### AI 辅助开发

集成 Claude Code，通过自然语言即可：

- 📋 "列出所有表" - 查看所有 CRUD 设计
- 🔍 "查看 shop 表的结构" - 获取表详细设计
- ➕ "给 shop 表增加地址字段" - AI 自动修改表结构
- 🔄 "同步 shop 表到数据库" - 同步表结构到数据库
- 📝 "生成 shop 表的代码" - 生成完整 CRUD 代码
- 📊 "比对 shop 表的差异" - 查看代码变更

---

## ⚙️ 配置

### 1. API 配置（必需）

首次使用需要配置 API 域名和 token：

```bash
# 复制配置文件
cp addons/gs_developer/api_config.example.json addons/gs_developer/api_config.json

# 编辑配置
# api_domain: 改为您的域名（如 https://your-domain.com）
# access-token: 改为登录后从 cookie 中获取的值（登录凭证）
```

**配置示例** (`api_config.json`):
```json
{
  "api_domain": "https://your-domain.com",
  "access-token": "your-access-token-here"
}
```

**注意**: `api_config.json` 已在 `.gitignore` 中，不会提交到 Git。

---

## 🚀 在 Claude Code 中使用

### 方式 1：Slash 命令（推荐）

#### 当前项目（已配置）

**本项目已配置好 `/dev` 命令**，配置 API 后可直接使用：

```bash
/dev 列出所有表
/dev 查看 shop 表的结构
/dev 给 shop 表增加地址字段
/dev 同步 shop 表到数据库
/dev 生成 shop 表的代码
```

#### 其他项目（需要配置）

如果在其他项目中使用此插件：

```bash
# 1. 配置 API
cp addons/gs_developer/api_config.example.json addons/gs_developer/api_config.json
# 编辑 api_config.json

# 2. 复制命令配置
cp addons/gs_developer/docs/commands/dev.md .claude/commands/dev.md

# 3. 重启 Claude Code 后即可使用
/dev 列出所有表
```

---

### 方式 2：自然语言（无需配置）

直接对 Claude Code 说自然语言，无需 `/dev` 命令：

```
"列出所有表"
"查看 shop 表的结构"
"给 shop 表增加一个地址字段"
"比对 shop 表的差异"
"同步 shop 表到数据库"
"生成 shop 表的代码并写入本地"
```

Claude Code 会自动读取文档并调用 API。

---

## 📖 详细文档

### 核心文档

- **[docs/commands/dev.md](docs/commands/dev.md)** - Claude Code 命令完整说明（推荐）
  - 所有 8 个工具的详细说明
  - 完整的参数和返回值说明
  - 实际工作流程示例
  - 常见任务速查表

- **[docs/DATABASE_API.md](docs/DATABASE_API.md)** - REST API 接口文档
  - API 调用格式和响应格式
  - 详细的工作流示例
  - 故障排查指南

### 可选文档（MCP 方式）

如果您想使用 MCP 协议（Model Context Protocol）连接，可以参考：

- **[docs/MCP_QUICK_START.md](docs/MCP_QUICK_START.md)** - MCP 快速开始
- **[docs/CLAUDE_MCP_GUIDE.md](docs/CLAUDE_MCP_GUIDE.md)** - Claude MCP 指南
- **[docs/MCP_CONFIG_GUIDE.md](docs/MCP_CONFIG_GUIDE.md)** - MCP 配置指南
- **[docs/README_MCP.md](docs/README_MCP.md)** - MCP 完整文档

**注意**：推荐使用 Slash 命令或自然语言方式，MCP 配置较复杂。

---

## 🔧 后台配置

### Access Token 验证

API 调用需要 Access Token 进行身份验证：

**获取方式**：
1. 登录到系统后台
2. 打开浏览器开发者工具（F12）
3. 在 Cookie 中查找 `access-token` 字段
4. 复制其值到 `api_config.json` 配置文件中

**说明**：
- access-token 是登录凭证，相当于用户的登录状态
- 需要在 `api_config.json` 中配置此值，Claude Code 才能调用 API
- 如果 access-token 过期，需要重新登录获取新的值

---

## 🛠️ 可用的 8 个工具

| 工具名称 | 功能说明 | 常用场景 |
|---------|---------|---------|
| `gs_dev_list_tables` | 列出所有表 | 查看所有 CRUD 设计 |
| `gs_dev_get_table_design` | 获取表设计 | 查看表的完整结构 |
| `gs_dev_update_table_design` | 更新表设计 ⭐ | 修改字段、表单、表格配置 |
| `gs_dev_sync_db` | 同步数据库 | 创建表或修改表结构 |
| `gs_dev_generate_code` | 生成代码 | 生成完整 CRUD 代码 |
| `gs_dev_diff_code` | 比对差异 | 查看新旧代码变化 |
| `gs_dev_create_table` | 创建新表 | 快速初始化表设计 |
| `gs_dev_get_history` | 查看历史 | 查看修改记录，支持回滚 |

**详细说明**：[docs/commands/dev.md](docs/commands/dev.md)

---

## 📂 目录结构

```
addons/gs_developer/
├── docs/                           # 📁 文档目录
│   ├── commands/
│   │   └── dev.md                 # Claude Code 命令详细说明
│   ├── DATABASE_API.md            # REST API 接口文档
│   ├── MCP_QUICK_START.md         # MCP 快速开始（可选）
│   ├── CLAUDE_MCP_GUIDE.md        # Claude MCP 指南（可选）
│   ├── MCP_CONFIG_GUIDE.md        # MCP 配置指南（可选）
│   └── README_MCP.md              # MCP 完整文档（可选）
│
├── controller/
│   ├── Mcp.php                    # MCP/API 控制器
│   └── ...                        # 其他控制器
│
├── service/
│   ├── McpService.php             # MCP 服务类
│   └── ...                        # 其他服务类
│
├── model/                         # 数据模型
├── view/                          # 视图文件
├── frontend/admin/                # Vue3 前端（开发者工具界面）
├── mcp_client.js                  # MCP 客户端（可选）
├── Plugin.php                     # 插件定义类
├── config.php                     # 插件配置
└── README.md                      # 本文档
```

---

## 🎯 使用示例

### 示例 1：给现有表增加字段

```
你: /dev 给 shop 表增加一个地址字段

Claude Code:
1. 获取当前设计...
2. 添加地址字段到 fieldItems...
3. 添加地址表单项到 formItems...
4. 添加地址列到 columnItems...
5. 保存设计...
6. 同步数据库...
7. 生成代码...

✅ 完成！已成功添加地址字段并同步到数据库。
```

### 示例 2：创建新表并生成代码

```
你: /dev 创建一个商品表，包含名称、价格、状态字段

Claude Code:
1. 创建表设计...
2. 添加字段...
3. 同步数据库...
4. 生成代码...

✅ 已生成以下文件：
- Controller: addons/your_addon/controller/admin/Product.php
- Model: addons/your_addon/model/Product.php
- Vue Page: frontend/admin/src/views/product/index.vue
- API: frontend/admin/src/api/product.js
- Router: frontend/admin/src/router/product.js
```

### 示例 3：比对代码差异

```
你: /dev 比对 shop 表的差异

Claude Code:
检测到以下变更：
- Controller: 新增 15 行，删除 3 行
- Model: 无变化
- Vue Page: 新增 5 行

安全合并评分：95%
建议：变更较小，可以安全覆盖
```

---

## ⚙️ API 配置说明

### 配置文件

API 配置存储在 `addons/gs_developer/api_config.json`：

```json
{
  "api_domain": "https://your-domain.com",
  "access-token": "your-access-token-here"
}
```

### API 地址

- **格式**: `{api_domain}/gs_developer/mcp/call`
- **生产环境**: `https://your-domain.com/gs_developer/mcp/call`
- **开发环境**: `http://localhost/gs_developer/mcp/call`

### 认证方式

- **请求头**: `Content-Type: application/json`, `access-token: 配置文件中的值`
- **响应码**: `code=0` 表示成功，`code=-1` 表示失败

### 调用示例（开发者参考）

```bash
# 从配置文件读取域名和 access-token
API_DOMAIN=$(cat addons/gs_developer/api_config.json | grep api_domain | cut -d'"' -f4)
ACCESS_TOKEN=$(cat addons/gs_developer/api_config.json | grep access-token | cut -d'"' -f4 | head -1)

# 调用 API
curl -X POST "${API_DOMAIN}/gs_developer/mcp/call" \
  -H "Content-Type: application/json" \
  -H "access-token: ${ACCESS_TOKEN}" \
  -d '{
    "tool": "gs_dev_list_tables",
    "arguments": {
      "addon_name": "go_review"
    }
  }'
```

---

## 📝 常见问题

### Q: 首次使用需要做什么？

A: 需要配置 API：

```bash
# 1. 复制配置文件
cp addons/gs_developer/api_config.example.json addons/gs_developer/api_config.json

# 2. 编辑 api_config.json，修改域名和 token
```

### Q: 如何在其他项目中使用？

A: 复制两个文件：

```bash
# 1. 复制 API 配置
cp addons/gs_developer/api_config.example.json api_config.json
# 编辑 api_config.json

# 2. 复制命令配置
cp addons/gs_developer/docs/commands/dev.md .claude/commands/dev.md

# 3. 重启 Claude Code
```

### Q: 可以不用 `/dev` 命令吗？

A: 可以！直接用自然语言对 Claude Code 说话即可，例如"列出所有表"。

### Q: Access Token 是必须配置的吗？

A: 是的。access-token 是登录凭证，需要登录后从 cookie 中获取并配置到 `api_config.json` 中。

### Q: 生成的代码会覆盖我的自定义修改吗？

A: 不会。可以先用"比对差异"功能查看变更，Claude Code 会智能识别并提示是否安全合并。

### Q: 支持哪些数据库？

A: 目前支持 MySQL (utf8mb4)。

---

## 🤝 贡献与反馈

如有问题或建议，欢迎联系：

- **作者**: 刘泓宾
- **Email**: 514660094@qq.com
- **项目**: 多客怪兽 SaaS 框架

---

## 📜 许可证

本插件遵循项目主框架许可证。

---

**开始使用 Claude Code，体验 AI 辅助的 CRUD 开发吧！🚀**