mcpField
D
docs-react

docs-react

github.com/imgly开发9135 次安装1 天前更新
代码仓库

关于 docs-react

用于查询 IMG.LY CreativeEditor SDK (React) 文档的技能。它按问题选择相关页面，并支持查找 API 参考，同时提醒核对 SDK 版本及本地规则。

主要功能

  1. 01查询 React 文档页面
  2. 02查找 TypeScript API 参考
  3. 03核对版本与更新日志
  4. 04提供常见问题的本地规则
  5. 05指导获取在线文档

适用场景

  1. 01查找 CE.SDK React 配置说明
  2. 02核对 API 方法签名或类型
  3. 03确认特定 SDK 版本的指引

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/imgly/agent-skills --skill docs-react

安装后在 Claude Code 中输入/docs-react确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
react.md
update-check.md
rules/
asset-handling.md
common-pitfalls.md
content-fill-mode.md
silent-init-errors.md
strict-mode-double-mount.md
verify-properties-before-use.md

详细介绍

版本说明

CE.SDK 1.83.0 · 生成日期：2026-09-30 · 插件 cesdk · 权威更新来源：imgly/agent-skills。

如果此捆绑包已过期六周以上，或用户询问更新，请在每项任务中按照 references/update-check.md 执行一次检查，并将结果用于所有 CE.SDK 技能。检查时仅限读取。未经用户明确批准，不得安装、更新、覆盖或删除任何内容。 除非用户批准更新，否则请继续使用此捆绑包。

CE.SDK React 文档

查询 IMG.LY CreativeEditor SDK（React）文档。

查询：$ARGUMENTS

远程文档

此技能会读取 https://img.ly/docs/cesdk/react/ 上的 CE.SDK 文档。 网站仅提供最新稳定版 CE.SDK，没有旧版本文档。 此捆绑包适用于 CE.SDK 1.83.0。如果项目使用其他 CE.SDK 版本， 请阅读变更日志和升级页面，并检查已安装软件包的类型定义。

使用方法

  1. 阅读索引：阅读 references/react.md。其中列出了所有 React 页面及其 标题和链接。
  2. 选择页面：挑选与查询相关的页面。
  3. 以 Markdown 格式获取每个页面：从链接中移除末尾的 /，并添加 .md。 例如，https://img.ly/docs/cesdk/react/export-save-publish/export/to-png-f87eaf/ 会变为 https://img.ly/docs/cesdk/react/export-save-publish/export/to-png-f87eaf.md。 使用 WebFetch。如果 WebFetch 不可用（例如在 Codex 中），请使用 curl -sL <url>。
  4. 仅依据获取的页面作答：提供相关章节和代码示例，并引用页面 URL。如果没有页面涵盖 用户的问题，请如实说明。不得用预训练知识填补内容空缺。
  5. 检查规则：在进行设置、初始化或常见操作之前，请阅读本地的 rules/*.md 文件。其中列出了网站文档未涵盖的 Agent 易犯问题。

API 查询

对于 TypeScript API 查询（方法签名、类型、参数）：

  • Editor API（@cesdk/cesdk-js）：https://img.ly/docs/cesdk/react/api/cesdk-js.md
  • Engine API（@cesdk/engine）：https://img.ly/docs/cesdk/react/api/engine.md

类和类型页面遵循相同的 .md 规则。例如： https://img.ly/docs/cesdk/react/api/engine/classes/blockapi.md。

提示：请根据 TypeScript 定义验证类型。CE.SDK 迭代迅速，类型结构可能与预训练知识不同。

全文

https://img.ly/docs/cesdk/react/llms-full.txt 包含所有 React 页面，合并为一个文件 （数 MB）。仅在最后考虑使用，即索引和页面都无法回答查询时。使用 curl -sL <url> | grep -n "<keyword>" 搜索。不要通读全文。

本地规则

  • rules/asset-handling.md：图像格式建议、URI 解析
  • rules/common-pitfalls.md：关键注意事项（不可见填充、SVG 渲染问题）
  • rules/content-fill-mode.md：contentFillMode 应设置在区块上，而非填充上
  • rules/silent-init-errors.md：CreativeEditor 初始化回调会静默吞掉错误
  • rules/strict-mode-double-mount.md：React Strict Mode 会在开发环境中运行两次 init
  • rules/verify-properties-before-use.md：获取或设置属性之前，先调用 engine.block.findAllProperties()

其他触发条件

此技能也适用于 CE.SDK 区块类型、资源来源和功能能力相关的查询。 它还处理 API 方法查询，包括 BlockAPI、SceneAPI、EditorAPI、AssetAPI、方法签名、 返回类型以及“engine.block”风格的查询。

相关技能

  • 用户需要实现方面的帮助，而不只是查阅文档时，请使用 `/imgly-sdk:build`
  • 对于超出文档范围的概念性解释，请使用 `/imgly-sdk:explain`

评论

支持 Markdown