mcpField
S
skill-creator

skill-creator

github.com/zrt-ai-labAgent 工作流29665 次安装14 周前更新
代码仓库

关于 skill-creator

面向 AI Agent 的技能,介绍如何设计、构建、打包和迭代可复用技能,涵盖 SKILL.md 结构、配套资源、渐进式披露及验证打包流程。

主要功能

  1. 01技能结构和元数据指导
  2. 02规划脚本、参考资料和资源
  3. 03渐进式披露设计
  4. 04技能初始化与编辑流程
  5. 05验证并打包为 ZIP

适用场景

  1. 01创建可复用的 Agent 技能
  2. 02组织脚本和参考资料
  3. 03改进技能说明和配套资源
  4. 04验证并打包技能以供分发

安装

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

$npx skills add https://github.com/zrt-ai-lab/opencode-skills --skill skill-creator

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

附带文件scripts/init_skill.pyscripts/package_skill.py

详细介绍

技能创建器

此技能提供创建高效技能的指导。

关于技能

技能是模块化、独立的程序包,通过提供专业知识、工作流和工具来扩展 AI Agent 的能力。可以将它们视为针对特定领域或任务的“入门指南”——它们能将通用 Agent 转变为具备程序性知识的专业 Agent,而这些知识是任何模型都无法完全掌握的。

技能提供的内容
  1. 专业工作流 - 针对特定领域的多步骤流程
  2. 工具集成 - 使用特定文件格式或 API 的说明
  3. 领域专业知识 - 公司专属知识、架构、业务逻辑
  4. 捆绑资源 - 用于复杂且重复任务的脚本、参考资料和素材
技能的组成

每项技能都包含一个必需的 SKILL.md 文件,以及可选的捆绑资源:

skill-name/
├── SKILL.md (required)
│   ├── YAML frontmatter metadata (required)
│   │   ├── name: (required)
│   │   └── description: (required)
│   └── Markdown instructions (required)
└── Bundled Resources (optional)
    ├── scripts/          - Executable code (Python/Bash/etc.)
    ├── references/       - Documentation intended to be loaded into context as needed
    └── assets/           - Files used in output (templates, icons, fonts, etc.)
SKILL.md(必需)

元数据质量: YAML frontmatter 中的 name 和 description 决定 Agent 何时使用该技能。请具体说明技能的功能及其适用场景。使用第三人称(例如:“此技能适用于……”而不是“在……时使用此技能”)。

捆绑资源(可选)
脚本(scripts/)

用于需要确定性可靠性的任务或经常重写的任务的可执行代码(Python/Bash 等)。

  • 适用场景:需要反复重写相同代码,或需要确定性可靠性时
  • 示例:用于 PDF 旋转任务的 scripts/rotate_pdf.py
  • 优势:节省令牌、结果确定、无需加载到上下文中即可执行
  • 注意:Agent 可能仍需阅读脚本,以便进行修补或针对特定环境进行调整
参考资料(references/)

用于按需加载到上下文中,为 Agent 的流程和思考提供参考的文档与资料。

  • 适用场景:Agent 工作时需要查阅文档
  • 示例:财务架构的 references/finance.md、公司 NDA 模板的 references/mnda.md、公司政策的 references/policies.md、API 规范的 references/api_docs.md
  • 用途:数据库架构、API 文档、领域知识、公司政策、详细的工作流指南
  • 优势:让 SKILL.md 保持精简,仅在 Agent 判断需要时加载
  • 最佳实践:如果文件较大(超过 10k 个词),请在 SKILL.md 中加入 grep 搜索模式
  • 避免重复:信息应放在 SKILL.md 或 references 文件中,而不是两者兼放。除非详细信息确实是技能的核心内容,否则优先放入 references 文件;这样既能保持 SKILL.md 精简,也便于查找信息,而不会占用过多上下文窗口。SKILL.md 中仅保留必要的操作说明和工作流指南;将详细的参考资料、架构和示例移至 references 文件。
素材(assets/)

不用于加载到上下文中,而是供 Agent 在生成输出时使用的文件。

  • 适用场景:技能需要在最终输出中使用文件时
  • 示例:品牌素材 assets/logo.png、PowerPoint 模板 assets/slides.pptx、HTML/React 样板 assets/frontend-template/、字体排版文件 assets/font.ttf
  • 用途:模板、图片、图标、样板代码、字体、可复制或修改的示例文档
  • 优势:将输出资源与文档分开,让 Agent 无需加载文件即可使用
渐进式披露设计原则

技能采用三级加载系统,以高效管理上下文:

  1. 元数据(name + description) - 始终位于上下文中(约 100 个词)
  2. SKILL.md 正文 - 技能触发时加载(少于 5k 个词)
  3. 捆绑资源 - Agent 按需加载(不限量*)

*不限量是因为脚本无需读入上下文窗口即可执行。

技能创建流程

创建技能时,请按顺序遵循“技能创建流程”,仅在有明确理由表明某个步骤不适用时才跳过。

第 1 步:通过具体示例了解技能

仅当技能的使用模式已经清晰明确时,才跳过此步骤。即使是在使用现有技能时,这一步也很有价值。

要创建有效的技能,必须清楚了解该技能的具体使用方式。这种了解可以来自用户提供的直接示例,也可以来自经用户反馈验证过的生成示例。

例如,构建图像编辑器技能时,相关问题包括:

  • “图像编辑器技能应支持哪些功能?编辑、旋转,还是其他功能?”
  • “能否给出一些使用此技能的示例?”
  • “我能想到用户可能会问‘去掉这张图片中的红眼’或‘旋转这张图片’。你觉得还会有哪些用法?”
  • “用户说什么时,应该触发此技能?”

为避免让用户应接不暇,不要在一条消息中提出太多问题。先问最重要的问题,再视需要跟进,以便进一步了解。

当你清楚了解技能应支持的功能后,即可结束此步骤。

第 2 步:规划可复用的技能内容

要将具体示例转化为有效的技能,请针对每个示例进行分析:

  1. 思考如何从头开始完成该示例
  2. 确定反复执行这些工作流时,哪些脚本、参考资料和资源会有所帮助

示例:构建 pdf-editor 技能来处理“帮我旋转这个 PDF”之类的请求时,分析表明:

  1. 每次旋转 PDF 都需要重新编写相同的代码
  2. 将 scripts/rotate_pdf.py 脚本存放在技能中会有所帮助

示例:设计 frontend-webapp-builder 技能来处理“帮我构建一个待办事项应用”或“帮我构建一个用于追踪步数的仪表板”之类的请求时,分析表明:

  1. 编写前端 Web 应用时,每次都需要相同的 HTML/React 样板代码
  2. 将包含 HTML/React 项目样板文件的 assets/hello-world/ 模板存放在技能中会有所帮助

示例:构建 big-query 技能来处理“今天有多少用户登录了?”之类的请求时,分析表明:

  1. 每次查询 BigQuery 都需要重新查找表架构和关系
  2. 将记录表架构的 references/schema.md 文件存放在技能中会有所帮助

要确定技能的内容,请分析每个具体示例,并整理出要纳入的可复用资源清单:脚本、参考资料和资源。

第 3 步:初始化技能

此时即可开始创建技能。

仅当要开发的技能已经存在,且需要迭代或打包时,才跳过此步骤。在这种情况下,请继续下一步。

从头创建新技能时,务必运行 init_skill.py 脚本。此脚本会便捷地生成一个新的技能模板目录,自动包含技能所需的全部内容,从而使技能创建过程更加高效、可靠。

用法:

scripts/init_skill.py <skill-name> --path <output-directory>

该脚本会:

  • 在指定路径创建技能目录
  • 生成带有正确 frontmatter 和 TODO 占位内容的 SKILL.md 模板
  • 创建示例资源目录:scripts/、references/ 和 assets/
  • 在每个目录中添加可自定义或删除的示例文件

初始化后,请根据需要自定义或移除生成的 SKILL.md 和示例文件。

步骤 4:编辑技能

编辑(新生成或现有的)技能时,请记住,创建该技能是为了让 AI Agent 使用。重点纳入对 Agent 有帮助且不显而易见的信息。考虑哪些流程知识、领域专属细节或可复用资源能帮助 Agent 更高效地执行这些任务。

从可复用的技能内容入手

开始实施时,先处理上文确定的可复用资源:scripts/、references/ 和 assets/ 文件。请注意,此步骤可能需要用户提供输入。例如,实现 brand-guidelines 技能时,用户可能需要提供品牌素材或模板,以便存入 assets/,或提供文档以便存入 references/。

同时,删除技能不需要的示例文件和目录。初始化脚本会在 scripts/、references/ 和 assets/ 中创建示例文件以展示结构,但大多数技能并不需要全部示例。

更新 SKILL.md

写作风格: 整个技能都使用祈使式或不定式形式(动词开头的指令),不要使用第二人称。采用客观、指令性的语言(例如,“要完成 X,请执行 Y”,而不是“你应该执行 X”或“如果你需要执行 X”)。这样可确保内容一致清晰,便于 AI 使用。

完善 SKILL.md 时,请回答以下问题:

  1. 技能的用途是什么?用几句话说明。
  2. 应在何时使用该技能?
  3. 在实际操作中,Agent 应如何使用该技能?引用上文开发的所有可复用技能内容,让 Agent 知道如何使用它们。
步骤 5:打包技能

技能准备就绪后,应将其打包成可分发的 zip 文件并分享给用户。打包流程会先自动验证技能,确保其符合所有要求:

scripts/package_skill.py <path/to/skill-folder>

可选的输出目录指定方式:

scripts/package_skill.py <path/to/skill-folder> ./dist

打包脚本将:

  1. 验证技能,自动检查:

    • YAML frontmatter 格式和必填字段
    • 技能命名规范和目录结构
    • 描述的完整性和质量
    • 文件组织和资源引用
  2. 验证通过后打包技能,创建一个以技能命名的 zip 文件(例如,my-skill.zip),其中包含所有文件,并保留适用于分发的正确目录结构。

如果验证失败,脚本会报告错误并退出,不会创建打包文件。修复所有验证错误后,再次运行打包命令。

步骤 6:迭代

测试技能后,用户可能会要求改进。通常,这会发生在用户刚使用完技能时,此时他们对技能的表现记忆犹新。

迭代工作流:

  1. 在实际任务中使用技能
  2. 留意遇到的困难或低效之处
  3. 确定应如何更新 SKILL.md 或随附资源
  4. 实施更改并再次测试

评论

支持 Markdown