Skip to main content
Glama
dudachun

DC-COCO-MCP

by dudachun
README.md
# DC-COCO-MCP

DC-COCO-MCP 是一个 clean-room 自研的 Cocos Creator MCP 扩展,用于让 AI 客户端通过 MCP 调用控制 Cocos Creator 编辑器中的项目、场景、节点、组件、资源、Prefab、构建和诊断流程。

本项目目标是成为 Cocos Creator 日常开发工具,而不是商业插件源码的反编译版本。

## 当前状态

- Cocos Creator 兼容目标:`3.8.8` 优先,保留 `>=3.7.0` 的兼容意图。
- MCP endpoint:默认 `http://127.0.0.1:3000/mcp`。
- 语言与工具链:TypeScript、pnpm、`@modelcontextprotocol/sdk`。
- 当前实现范围:P0-P4 基础能力、操作安全、组件 schema、资源系统、Builder 生产化和面板控制台的第一版。

## 已实现能力

- Cocos Creator 扩展壳:菜单、面板、生命周期、设置、日志、服务启停、场景脚本。
- MCP HTTP 服务:支持 `initialize`、`tools/list`、`tools/call`。
- 统一工具返回:`ok`、`data`、`changeSummary`、`warnings`、`errors`、`artifacts`。
- 场景与节点:项目信息、场景树、节点查找、节点信息、创建、更新、删除、重挂父节点。
- 组件:组件列表、添加、更新、删除、schema 查询和参数校验。
- 资源:搜索、信息、`.meta`、刷新、依赖、被依赖、移动、删除、导入图片、SpriteFrame 解析。
- Prefab:创建、实例化、信息读取、保存、解绑。
- Builder:预设、运行、状态、日志、诊断、输出目录打开和清理。
- 操作安全:操作历史、备份、撤销、dry-run、批量预览。
- 面板控制台:项目状态、MCP 状态、工具管理、常用动作、日志诊断。

## Clean-room 边界

本项目只做功能级自研实现:

- 不反混淆商业插件。
- 不复制商业插件源码、UI、授权逻辑、sidecar 或加密载荷。
- 功能设计依据来自公开 Cocos Creator 扩展 API、公开 MCP 协议、公开文档和自研能力拆解。

## 安装与开发

```bash
pnpm install
pnpm typecheck
pnpm build
pnpm test
pnpm lint
```

开发构建完成后,把项目目录作为 Cocos Creator 扩展放入目标项目的 `extensions/dc-coco-mcp`,或使用符号链接指向本仓库。

## 常用命令

```bash
pnpm build
pnpm typecheck
pnpm test
pnpm lint
pnpm smoke
```

## 验收报告

完整阶段性实现与验收记录见:

- [IMPLEMENTATION_REPORT.md](./IMPLEMENTATION_REPORT.md)

## 许可证

当前仓库公开可见,但还没有授予开源许可证。未经作者明确授权,不应复制、分发或商用本项目代码。