cocos-mcp

Cocos Creator 3.8.x 的 MCP 桥接扩展 + 离线 prefab 读写 CLI。

把编辑器的 scene/asset/preview/local 能力以 MCP 协议暴露给 Claude Code；同时提供无需编辑器运行的 offline prefab 编辑能力，支持节点增删克隆与 stub 节点属性覆写。

文档导航

Related MCP server: Cocos MCP Server

架构

Claude Code (MCP client)
        │  stdio (JSON-RPC)
        ▼
┌─────────────────────────────┐
│  router/bin.js              │  ← 统一入口，聚合多个编辑器
│  - 扫 ~/.cocos-mcp/editors/ │
│  - offline prefab tools     │
└───────────┬─────────────────┘
            │  HTTP MCP (JSON-RPC)
    ┌───────┴────────┐
    │                │
    ▼                ▼
编辑器实例 A      编辑器实例 B       ← 每个项目一个编辑器进程
server/mcp-server.js              ← 在 Cocos 编辑器进程内跑 HTTP MCP server

offline prefab tools（prefab_query / prefab_edit / prefab_batch）在 router 进程内直接执行，调用 cli/src/index.js，不需要编辑器运行。

三个组件

1. 编辑器扩展（main.js + panel + server）

在 Cocos Creator 编辑器进程内运行。启动时拉起 server/mcp-server.js（HTTP MCP server），并把自身信息写入 ~/.cocos-mcp/editors/<pid>.json（心跳注册）。

暴露的 tool 域：

2. stdio router（router/）

入口：router/bin.js

职责：

• 扫描 ~/.cocos-mcp/editors/ 发现活跃编辑器（心跳超 120s 视为已死）

• 每隔 15s 自动发现新实例

• 给每个编辑器的 tool 加 <shortName>__ 前缀，合并后暴露给 Claude Code

• 内置 offline prefab tools（prefab_query / prefab_edit / prefab_batch），不带前缀，全局可用

tool 路由示例：

forest__scene_query_node_tree  →  forest 编辑器的 HTTP MCP server
another__asset_query_assets    →  another 编辑器的 HTTP MCP server
prefab_query                   →  router 本地执行（cli），无需编辑器

3. cocos-mcp-cli（cli/）

零依赖 Node CLI，直接读写 .prefab 文件，无需 Cocos 编辑器运行。详见 doc/cli.md。

功能面板

通过菜单「扩展 → Cocos MCP → 功能面板」打开，或在编辑器扩展面板停靠。

自定义 Debug 按钮：在项目根目录新建 .dev/cc-mcp-panel.json：

{ "buttons": [{ "label": "解锁签到", "code": "app.userMod.setUserValue(0,1)" }] }

Tools 清单

scene 域（需编辑器运行）

修改 prefab 资源文件属性建议用 prefab_edit（offline），scene_set_property 只适用于运行时节点或需要编辑器上下文的情况。

asset-db 域（需编辑器运行）

preview 域（需编辑器运行）

预览页面截图、点击、JS 执行等浏览器交互不由本扩展注册 preview tool，agent 应先用 preview_query_url 获取当前 URL，再交给 Playwright / Chrome 验证真实页面。

local 域（需编辑器运行）

offline 域（router 级，无需编辑器运行）

完整 op 列表与配方见 doc/cli.md。

offline tools 的 filePath 和 opsJsonPath 必须为绝对路径；router 以 stdio 模式运行，cwd 不确定，相对路径有歧义。

多开支持

每个 Cocos 编辑器实例启动时向 ~/.cocos-mcp/editors/<pid>.json 写入注册信息：

{
  "pid": 12345,
  "url": "http://127.0.0.1:7788/mcp",
  "shortName": "forest",
  "projectPath": "/path/to/project"
}

router 定期扫此目录，心跳超过 120s 的记录视为死亡自动剔除。tool 名以 <shortName>__ 为前缀隔离，同机多开不冲突。

接入 Claude Code

⚠️ 本仓库通过 git submodule 依赖 universal-mcp-sdk，clone 后必须先拉 submodule，否则 MCP server 起不来：

git submodule update --init --recursive

claude mcp add cocos -- node /path/to/cocos-mcp/router/bin.js

接入后 Claude Code 即可调用所有活跃编辑器的 tool，以及全局 offline prefab tools。

.dev/refresh 信号协议

外部往 <project>/.dev/refresh 文件写一行命令，编辑器扩展的 watcher 读到后执行并清空文件。fire-and-forget，无返回值。

协议精简：只支持 restart-package——禁用→启用本扩展，让 main.js / tools.js / server/* 的代码改动生效。资源刷新 / 场景重载 / 预览刷新都走 MCP tool（preview_refresh_and_reload / asset_reimport 等）或面板按钮；浏览器截图和交互验证交给 Playwright / Chrome。

echo "restart-package" > .dev/refresh

面板上的「重启 MCP Server」按钮只重启 HTTP server 实例，Node require 缓存不动，改不到 main.js 的代码改动。restart-package 走 Editor.Package.disable + enable，整个扩展沙箱重建，所有 JS 重新 require。注意命令是 fire-and-forget，不返回结果；扩展重启过程中 MCP 连接会短暂中断（≈1-2s），重连由 router 自动发现完成。

已知限制

1. stub 节点的组件字段：set-label-text / set-sprite-frame / set-nested-component-field 已通过 uuid-resolver.js 解析 CompPrefabInfo.fileId 写入 stub 节点的 override

2. 多层嵌套 stub：CLI 已通过 refSubNode 字符串数组路径支持。极端深嵌套场景仍建议走 tools pipeline（tools/step-3-script/bind-prefab-components.ts）

3. offline 改完后需手动触发刷新：直接写磁盘 Cocos 编辑器不会自动感知。改完后调用 asset_reimport（编辑器在线时）或 preview_refresh_and_reload，否则编辑器和预览页面看到的仍是旧内容

反馈

使用本扩展（MCP tool / offline CLI）时遇到 bug、行为异常或文档与实际不符，agent 必须把问题反馈给用户，由用户决定是否修复扩展本身，不要在调用方加 workaround 绕过。