@yc-ugc/editor-mcp
v0.2.0
Published
UGC 编辑器 MCP 一键安装 CLI:将 UGC 编辑器能力(剧情/蓝图/UI 编辑、模块开发、AI 生成、运行时调试)接入 Claude Code / Codex / Cursor / Trae 等 AI 编码工具
Maintainers
Readme
@yc-ugc/editor-mcp
UGC 编辑器 MCP 一键安装 CLI。把 UGC 编辑器的 MCP 能力(剧情/蓝图/UI 编辑、UGC 模块开发、AI 素材生成、运行时截图调试)接入你正在使用的 AI 编码工具。
快速开始
在项目目录执行(<url> 为 MCP Server 地址、<token> 为编辑器「MCP 管理」页创建的 API Token):
npx -y @yc-ugc/editor-mcp install --url <url> --token <token>自动检测已安装的 Claude Code / Cursor / Codex / Trae 并写入 MCP 配置;也可指定:
npx -y @yc-ugc/editor-mcp install --url <url> --token <token> --ide claude,codex让 Agent 自动安装(把这句话发给你的 AI 工具即可):
执行 npx -y @yc-ugc/editor-mcp guide --url <url> --token <token>,并根据指引完成 UGC 编辑器 MCP 的安装。命令
| 命令 | 说明 |
|------|------|
| install | 写入各 AI 工具的 MCP 配置(缺省参数时交互式询问) |
| docs | 一键下载编辑器操作文档到工作区规则目录,并记录 docsVersion 到 .ugc-docs-version;--check 仅对比版本(一致退出码 0,不一致 2) |
| verify | 连接自检:initialize 握手 / tools/list 工具数量与模块分组 / 文档版本一致性,逐项报告 |
| remove | 从各 AI 工具配置中移除 UGC 编辑器 MCP 条目(缺省移除所有 ugc-editor* 条目;文档文件保留需手动删) |
| guide | 打印面向 AI Agent 的安装指引 |
docs 命令细节
# 下载全部文档(SKILL.md 主文档 + 领域规则参考)到规则目录
npx -y @yc-ugc/editor-mcp docs --url <url> --token <token>
# 仅对比本地 .ugc-docs-version 与服务端 docsVersion(可挂任务前置 hook)
npx -y @yc-ugc/editor-mcp docs --url <url> --token <token> --check规则目录默认按自动检测的工具推导(--dir 可显式指定):Claude Code → .claude/skills/ugc-editor/、Trae → .trae/rules/ugc-editor/、Cursor → .cursor/rules/ugc-editor/、Codex → docs/ugc-editor/。
参数
| 参数 | 说明 |
|------|------|
| --url <url> | MCP Server 地址,如 http://localhost:3000/api/mcp |
| --token <token> | API Token(ugc_ 开头) |
| --ide <ids> | 逗号分隔:claude,cursor,codex,trae,或 all |
| --dir <path> | 项目目录(项目级配置写入位置,默认当前目录) |
配置写入位置
| 工具 | 配置文件 |
|------|---------|
| Claude Code | <项目>/.mcp.json |
| Cursor | <项目>/.cursor/mcp.json |
| Trae | ~/.trae/mcp.json |
| Codex | ~/.codex/config.toml |
部分Agent 安装后可能需要重新启动才能加载 MCP。
下一步
连接成功后,把下面这段话发给 Agent,下载编辑器操作文档到工作区:
连接 UGC 编辑器 MCP,调用 mcp_list_skill_docs 获取文档清单,再逐份调用
mcp_get_skill_doc(按清单 id)下载全文,按清单中的 path 相对路径结构写入工作区规则目录完成安装。