skill-creator

Skill Creator

本 Skill 为创建有效的 Skill 提供指导。

关于 Skill

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

Skill 提供什么

1. 专门的工作流 - 针对特定领域的多步骤流程
2. 工具集成 - 处理特定文件格式或 API 的说明
3. 领域专业知识 - 公司特定的知识、模式、业务逻辑
4. 打包资源 - 用于复杂和重复性任务的脚本、参考资料和资产

核心原则

简洁是关键

上下文窗口是一种公共资源。Skill 与 Agent 所需的其他所有内容共享上下文窗口：系统提示词、对话历史、其他 Skill 的元数据以及用户的实际请求。

默认假设：Agent 已经具备能力。 只添加 Agent 尚未拥有的上下文。对每一条信息提出质疑：“Agent 真的需要这个解释吗？”以及“这段文字是否值得其 token 成本？”

优先使用简洁的示例，而不是冗长的解释。

设定适当的自由度

让具体程度与任务的脆弱性和可变性相匹配：

高自由度（基于文本的指令）：当多种方法都有效、决策取决于上下文，或启发式方法指导做法时使用。

中自由度（伪代码或带参数的脚本）：当存在首选模式、某些变化可以接受，或配置会影响行为时使用。

低自由度（特定脚本、少量参数）：当操作脆弱且易出错、一致性至关重要，或必须遵循特定顺序时使用。

把 Agent 想象成在探索一条路径：狭窄且旁边是悬崖的桥需要特定的护栏（低自由度），而开阔的田野则允许许多路线（高自由度）。

Skill 的剖析

每个 Skill 都由必需的 SKILL.md 文件和可选的打包资源组成：

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

SKILL.md（必需）

每个 SKILL.md 都由以下部分组成：

• Frontmatter（YAML）：包含 name 和 description 字段。这些是 Agent 用来判断何时使用该 Skill 的唯一字段，因此清晰而全面地描述该 Skill 是什么以及何时应使用它非常重要。
• 正文（Markdown）：使用该 Skill 的说明和指导。仅在 Skill 触发之后（如果会触发的话）才加载。

打包资源（可选）

脚本（scripts/）

用于需要确定性可靠性或会被反复重写的任务的可执行代码（TypeScript/Python/Bash 等）。

• 何时包含：当同一段代码被反复重写或需要确定性可靠性时
• 示例：用于 PDF 旋转任务的 scripts/rotate-pdf.ts
• 优点：节省 token、具有确定性、可以在不加载到上下文的情况下执行
• 注意：脚本可能仍需要由 Agent 读取，以便进行修补或针对特定环境的调整

References (references/)

用于按需加载到上下文中、为 Agent 的处理过程和思考提供信息的文档与参考资料。

• 何时包含：当 Agent 在工作时需要参考某些文档时
• 示例：references/finance.md 用于财务 schema，references/mnda.md 用于公司 NDA 模板，references/policies.md 用于公司政策，references/api_docs.md 用于 API 规范
• 使用场景：数据库 schema、API 文档、领域知识、公司政策、详细指南
• 优势：保持 SKILL.md 精简，仅在 Agent 判断需要时加载
• 最佳实践：如果文件较大（超过 1 万词），在 SKILL.md 中包含 grep 模式
• 避免重复：信息应只存在于 SKILL.md 或 references 文件中的一处，而非两者皆有。详细信息优先放在 references 文件中，除非它确实是技能的核心内容——这样既能保持 SKILL.md 精简，又能让信息可被发现而不占用上下文窗口。SKILL.md 中只保留必要的指令和工作流指导；将详细的参考资料、schema 和示例移到 references 文件中。

Assets (assets/)

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

• 何时包含：当技能需要用于最终输出的文件时
• 示例：assets/logo.png 用于品牌资源，assets/slides.pptx 用于 PowerPoint 模板，assets/frontend-template/ 用于 HTML/React 样板代码，assets/font.ttf 用于字体排版
• 使用场景：模板、图片、图标、样板代码、字体、被复制或修改的示例文档
• 优势：将输出资源与文档分离，使 Agent 无需加载到上下文即可使用文件

技能中不应包含的内容

技能应只包含直接支持其功能的必要文件。不要创建无关的文档或辅助文件，包括：

• README.md
• INSTALLATION_GUIDE.md
• QUICK_REFERENCE.md
• CHANGELOG.md
• 等等。

技能应只包含 AI Agent 完成当前任务所需的信息。它不应包含关于创建过程的辅助上下文、安装和测试流程、面向用户的文档等。创建额外的文档文件只会增加杂乱和困惑。

渐进式披露设计原则

技能使用三级加载系统来高效管理上下文：

1. 元数据（name + description） - 始终在上下文中（约 100 词）
2. SKILL.md 正文 - 当技能触发时（少于 5 千词）
3. 捆绑资源 - 由 Agent 按需加载（无限制，因为脚本可以在不读入上下文窗口的情况下执行）

渐进式披露模式

将 SKILL.md 正文保持在核心要点范围内，且不超过 500 行，以尽量减少上下文膨胀。当接近此限制时，将内容拆分到单独的文件中。将内容拆分到其他文件时，务必从 SKILL.md 中引用它们，并清楚地说明何时阅读它们，以确保技能的读者知道它们的存在以及何时使用它们。

关键原则： 当一个技能支持多种变体、框架或选项时，仅在 SKILL.md 中保留核心工作流和选择指南。将特定变体的细节（模式、示例、配置）移至单独的参考文件中。

模式 1：带参考的高层指南

# PDF Processing

## Quick start

Extract text with pdfplumber:
[code example]

## Advanced features

- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns

Agent 仅在需要时加载 FORMS.md、REFERENCE.md 或 EXAMPLES.md。

模式 2：按领域组织

对于具有多个领域的技能，按领域组织内容以避免加载无关上下文：

bigquery-skill/
├── SKILL.md (overview and navigation)
└── reference/
    ├── finance.md (revenue, billing metrics)
    ├── sales.md (opportunities, pipeline)
    ├── product.md (API usage, features)
    └── marketing.md (campaigns, attribution)

当用户询问销售指标时，Agent 仅读取 sales.md。

同样，对于支持多个框架或变体的技能，按变体组织：

cloud-deploy/
├── SKILL.md (workflow + provider selection)
└── references/
    ├── aws.md (AWS deployment patterns)
    ├── gcp.md (GCP deployment patterns)
    └── azure.md (Azure deployment patterns)

当用户选择 AWS 时，Agent 仅读取 aws.md。

模式 3：条件性细节

展示基本内容，链接到高级内容：

# DOCX Processing

## Creating documents

Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).

## Editing documents

For simple edits, modify the XML directly.

**For tracked changes**: See [REDLINING.md](REDLINING.md)
**For OOXML details**: See [OOXML.md](OOXML.md)

Agent 仅在用户需要这些功能时读取 REDLINING.md 或 OOXML.md。

重要指南：

• 避免深层嵌套引用 - 保持引用距离 SKILL.md 只有一层。所有参考文件都应直接从 SKILL.md 链接。
• 组织较长的参考文件 - 对于超过 100 行的文件，在顶部包含目录，以便 Agent 在预览时能看到完整范围。

技能创建流程

技能创建涉及以下步骤：

1. 通过具体示例理解技能
2. 规划可复用的技能内容（脚本、参考、资源）
3. 初始化技能（运行 init-skill.ts）
4. 编辑技能（实现资源并编写 SKILL.md）
5. 打包技能（运行 package-skill.ts）
6. 基于实际使用进行迭代

按顺序遵循这些步骤，仅在有明显理由不适用时跳过。

步骤 1：通过具体示例理解技能

仅在技能的使用模式已经清楚理解时才跳过此步骤。即使在使用现有技能时，它仍然有价值。

要创建有效的技能，需要清楚地理解技能将如何使用的具体示例。这种理解可以来自直接的用户示例，也可以来自经过用户反馈验证的生成示例。

例如，在构建图像编辑器技能时，相关问题包括：

• “图像编辑器技能应支持哪些功能？编辑、旋转，还有其他吗？”
• “你能给出一些这个技能如何使用的示例吗？”
• “我可以想象用户会提出诸如‘从此图像中移除红眼’或‘旋转此图像’之类的请求。你还能想象这个技能以其他方式使用吗？”
• “用户会说什么来触发这个技能？”

为避免让用户不堪重负，避免在单条消息中提出过多问题。从最重要的问题开始，并根据需要跟进以提高效果。

当对技能应支持的功能有清晰的了解时，结束此步骤。

第 2 步：规划可复用的 Skill 内容

要将具体示例转化为有效的 Skill，请通过以下方式分析每个示例：

1. 考虑如何从零开始执行该示例
2. 确定在反复执行这些工作流时，哪些脚本、参考文档和资源会有所帮助

示例：在构建 pdf-editor Skill 以处理诸如"帮我旋转这个 PDF"的查询时，分析表明：

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

示例：在设计 frontend-webapp-builder Skill 以处理诸如"帮我构建一个待办事项应用"或"帮我构建一个追踪步数的仪表盘"的查询时，分析表明：

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

示例：在构建 big-query Skill 以处理诸如"今天有多少用户登录了？"的查询时，分析表明：

1. 查询 BigQuery 每次都需要重新发现表结构和关系
2. 在 Skill 中存储一个记录表结构的 references/schema.md 文件会有所帮助

要确定 Skill 的内容，请分析每个具体示例，列出要包含的可复用资源：脚本、参考文档和资源文件。

第 3 步：初始化 Skill

至此，是时候实际创建 Skill 了。

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

从零开始创建新 Skill 时，始终运行 init-skill.ts 脚本。该脚本会便捷地生成一个新的模板 Skill 目录，自动包含 Skill 所需的一切，使 Skill 创建过程更加高效和可靠。

用法：

npx tsx scripts/init-skill.ts <skill-name> --path <output-directory>

该脚本：

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

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

第 4 步：编辑 Skill

在编辑（新生成或现有的）Skill 时，请记住该 Skill 是为另一个 AI Agent 使用而创建的。请包含对 Agent 有益且非显而易见的信息。考虑哪些过程性知识、领域特定细节或可复用资源能帮助另一个 Agent 更有效地执行这些任务。

学习经过验证的设计模式

根据 Skill 的需求查阅以下实用指南：

• 多步骤流程：参见 references/workflows.md 了解顺序工作流和条件逻辑
• 特定输出格式或质量标准：参见 references/output-patterns.md 了解模板和示例模式

这些文件包含经过验证的有效 Skill 设计最佳实践。

从可复用的 Skill 内容开始

要开始实现，请从上述确定的可复用资源入手：scripts/、references/ 和 assets/ 文件。注意此步骤可能需要用户输入。例如，在实现 brand-guidelines Skill 时，用户可能需要提供品牌资源或模板以存储在 assets/ 中，或提供文档以存储在 references/ 中。

添加的脚本必须通过实际运行来测试，以确保没有 bug 且输出符合预期。如果存在许多相似的脚本，只需测试具有代表性的样本，以在确保它们都能正常工作与平衡完成时间之间取得平衡。

Skill 不需要的任何示例文件和目录都应删除。初始化脚本会在 scripts/、references/ 和 assets/ 中创建示例文件以演示结构，但大多数 Skill 并不需要全部这些文件。

更新 SKILL.md

写作指南： 始终使用祈使/不定式形式。

Frontmatter

使用 name 和 description 编写 YAML frontmatter：

• name：技能名称
• description：这是技能的主要触发机制，可帮助 Agent 理解何时使用该技能。
  • 同时包含该技能的功能以及使用它的具体触发条件/场景。
  • 将所有“何时使用”的信息都放在这里——不要放在正文中。正文只在触发后才会加载，因此正文中的“何时使用此技能”部分对 Agent 没有帮助。
  • docx 技能的示例 description：“Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when an agent needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks”

不要在 YAML frontmatter 中包含任何其他字段。

正文

编写使用该技能及其捆绑资源的说明。

第 5 步：打包技能

技能开发完成后，必须将其打包为可分发的 .skill 文件，以便与用户共享。打包过程会首先自动验证技能，以确保其满足所有要求：

npx tsx scripts/package-skill.ts <path/to/skill-folder>

可选的输出目录指定：

npx tsx scripts/package-skill.ts <path/to/skill-folder> ./dist

打包脚本将：

1. 自动验证技能，检查：

   • YAML frontmatter 格式和必填字段
   • 技能命名规范和目录结构
   • description 的完整性和质量
   • 文件组织和资源引用

2. 如果验证通过，则打包技能，创建一个以技能命名的 .skill 文件（例如 my-skill.skill），其中包含所有文件，并保持适当的目录结构以便分发。.skill 文件是扩展名为 .skill 的 zip 文件。

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

第 6 步：迭代

测试技能后，用户可能会请求改进。这通常发生在使用技能之后，此时对技能的表现还有新鲜的上下文。

迭代工作流：

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