mcpField
D
docs-node

docs-node

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

关于 docs-node

面向 Node.js 项目的 IMG.LY CreativeEditor SDK 文档查询技能。它引导用户查找相关文档、API 参考和本地规则,并要求依据获取的页面作答。

主要功能

  1. 01查找相关的 Node.js 文档页面
  2. 02以 Markdown 获取文档
  3. 03查询 Node API 参考
  4. 04查阅本地实施规则

适用场景

  1. 01查找 CE.SDK Node.js 功能的使用说明
  2. 02核对 API 签名和类型
  3. 03在设置或常见操作前检查本地规则

安装

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

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

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

包含的文件

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

references/
node.md
update-check.md
rules/
asset-handling.md
common-pitfalls.md
content-fill-mode.md
silent-init-errors.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 Node.js 文档

查找 IMG.LY CreativeEditor SDK(Node.js)的文档。

查询:$ARGUMENTS

远程文档

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

使用方法

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

API 查询

对于 TypeScript API 查询(方法签名、类型、参数):

  • Node API(@cesdk/node):https://img.ly/docs/cesdk/node/api/node.md

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

提示:请依据 TypeScript 定义验证类型——CE.SDK 更新迅速,类型结构可能与预训练知识不同。

全文

https://img.ly/docs/cesdk/node/llms-full.txt 在一个文件中包含所有 Node.js 页面 (数 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/verify-properties-before-use.md:获取或设置属性前,先调用 engine.block.findAllProperties()

其他触发条件

此技能还涵盖有关 CE.SDK 区块类型、资源源和功能能力的查询。 它也处理 API 方法查询——BlockAPI、SceneAPI、EditorAPI、AssetAPI、方法签名、 返回类型,以及 engine.block 风格的查询。

相关技能

  • 用户需要实现帮助而非仅查阅文档时,请使用 `/imgly-sdk:build`
  • 用户需要文档未涵盖的概念性解释时,请使用 `/imgly-sdk:explain`

评论

支持 Markdown