mcpField
D
docs-vue

docs-vue

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

关于 docs-vue

docs-vue 是用于查询 IMG.LY CreativeEditor SDK（CE.SDK）Vue.js 文档的 Agent 技能，面向开发者。它按索引定位网页，并提供 API 查询指引和本地注意事项。

主要功能

  1. 01检索 Vue.js 文档
  2. 02按索引选择相关页面
  3. 03获取 Markdown 格式文档
  4. 04查询 Editor 与 Engine API
  5. 05查看本地开发注意事项

适用场景

  1. 01查找 CE.SDK 功能说明
  2. 02查询 BlockAPI 等 TypeScript API
  3. 03按版本差异核对文档与类型定义

安装

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

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

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

包含的文件

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

references/
update-check.md
vue.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 Vue.js 文档

查阅 IMG.LY CreativeEditor SDK（Vue.js）文档。

查询：$ARGUMENTS

远程文档

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

使用方法

  1. 阅读索引：阅读 references/vue.md。其中列出了所有 Vue.js 页面及其标题和链接。
  2. 选择页面：挑选与查询相关的页面。
  3. 以 Markdown 格式获取每个页面：从链接中移除末尾的 /，并添加 .md。 例如，https://img.ly/docs/cesdk/vue/export-save-publish/export/to-png-f87eaf/ 会变为 https://img.ly/docs/cesdk/vue/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/vue/api/cesdk-js.md
  • Engine API（@cesdk/engine）：https://img.ly/docs/cesdk/vue/api/engine.md

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

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

全文

https://img.ly/docs/cesdk/vue/llms-full.txt 包含一个文件中的所有 Vue.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