mcpField
D
docs-sveltekit

docs-sveltekit

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

关于 docs-sveltekit

docs-sveltekit 是面向 IMG.LY CreativeEditor SDK(SvelteKit)的文档查询技能,指导 Agent 查找相关文档、核对 API 细节并遵循本地规则。

主要功能

  1. 01查询 SvelteKit 文档
  2. 02查询 TypeScript API 参考
  3. 03提供本地实现规则
  4. 04版本与更新指引

适用场景

  1. 01查找 SvelteKit 集成说明
  2. 02核对 BlockAPI 或 Engine API 细节
  3. 03检查资源与初始化注意事项

安装

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

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

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

包含的文件

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

references/
sveltekit.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 SvelteKit 文档

查询 IMG.LY CreativeEditor SDK(SvelteKit)文档。

查询:$ARGUMENTS

远程文档

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

使用方法

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

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

提示:请对照 TypeScript 定义验证类型——CE.SDK 迭代迅速,类型结构可能与预训练知识不同。

全文

https://img.ly/docs/cesdk/sveltekit/llms-full.txt 包含一个文件中的所有 SvelteKit 页面 (数 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