mcpField
D
docs-nextjs

docs-nextjs

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

关于 docs-nextjs

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

主要功能

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

适用场景

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

安装

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

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

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

包含的文件

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

references/
nextjs.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 Next.js 文档

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

查询:$ARGUMENTS

远程文档

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

使用方法

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

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

提示:请根据 TypeScript 定义核实类型——CE.SDK 发展迅速,类型结构可能与预训练知识不同。

全文

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