如何创建一个 Agent Skill？

小星星_ios
4 阅读13分钟

关于 Skill

技能是模块化、自包含的软件包，通过提供专业知识、工作流程和工具来扩展 claude 的能力。可以将它们视为特定领域或任务的"入门指南"——它们将 claude 从通用代理转变为配备程序性知识的专业代理，这些知识是任何模型都无法完全掌握的。

Skill 提供了什么？

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

核心原则

简洁是关键

上下文窗口是公共资源。技能会将上下文窗口与 claude 所需的其他所有内容共享：系统提示、对话历史记录、其他技能的元数据以及用户的实际请求。

默认假设：claude 已经非常聪明。 只添加 claude 原本不了解的背景信息。对每条信息都进行质疑：“claude 真的需要这个解释吗？”以及“这段文字的字数成本合理吗？”

比起冗长的解释，更倾向于简洁的例子。

设定适当的自由度

根据任务的脆弱性和可变性调整具体程度：

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

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

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

把 claude 想象成探索一条道路：一条有悬崖的狭窄桥梁需要特定的护栏（自由度低），而一片开阔的田野则允许许多路线（自由度高）。

技能剖析

每项技能都包含一个必需的 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（必填）

每个 SKILL.md 文件都包含：

  • Frontmatter（YAML）：包含 <skill-name> name 和`description` 字段。claude 仅读取这些字段来判断技能何时使用，因此清晰全面地描述技能及其使用时机至关重要。
  • 正文（Markdown）：技能使用说明和指南。仅在技能触发后加载。

捆绑资源（可选）

脚本（scripts/）

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

  • 何时需要包含：当相同的代码被反复重写或需要确定性可靠性时。
  • 例如：scripts/rotate_pdf.py用于 PDF 旋转任务
  • 优点：令牌高效、确定性强，无需加载到上下文即可执行
  • 注意：Claude 可能仍然需要读取脚本以进行修补或针对特定环境的调整。
参考 （references/）

文档和参考资料旨在根据需要加载到上下文中，以指导 Claude 的创作过程和思考。

  • 何时包含：供 claude 在工作时参考的文档
  • 例如：references/finance.md财务模式、references/mnda.md公司保密协议模板、references/policies.md公司政策、references/api_docs.mdAPI规范
  • 使用场景：数据库模式、API文档、领域知识、公司政策、详细工作流程指南
  • 优点：保持 SKILL.md 文件精简，仅在 Claude 认为需要时才加载。
  • 最佳实践：如果文件较大（>10k 个单词），请在 SKILL.md 文件中包含 grep 搜索模式。
  • 避免重复：信息应仅存在于 SKILL.md 文件或参考文件中，两者不可兼得。除非信息对技能至关重要，否则应优先将其放在参考文件中——这样既能保持 SKILL.md 的简洁性，又能确保信息易于查找，且不会占用过多上下文窗口。SKILL.md 中仅保留必要的操作步骤说明和工作流程指南；将详细的参考资料、模式和示例移至参考文件中。
资产（assets/）

这些文件并非旨在加载到上下文中，而是用于 Claude 生成的输出中。

  • 何时包含：当技能需要最终输出中使用的文件时
  • 例如：assets/logo.png品牌资产、assets/slides.pptxPowerPoint模板、assets/frontend-template/HTML/React样板代码、assets/font.ttf排版
  • 使用场景：模板、图像、图标、样板代码、字体、示例文档等，这些内容会被复制或修改。
  • 优点：将输出资源与文档分离，使 Claude 能够在不将文件加载到上下文中的情况下使用它们。

技能中不应包含哪些内容

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

  • README.md
  • 安装指南.md
  • 快速参考.md
  • 更新日志.md
  • ETC。

技能本身应该只包含人工智能代理完成当前任务所需的信息，而不应该包含创建过程、设置和测试步骤、用户文档等辅助信息。创建额外的文档文件只会增加混乱和冗余。

渐进式披露设计原则

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

  1. 元数据（名称 + 描述）： 始终与上下文相关（约 100 字）
  2. SKILL.md 正文： 技能触发时（小于 5000 字）
  3. 捆绑资源： 根据 claude 的需要（数量不限，因为脚本无需读取上下文窗口即可执行）

渐进式披露模式

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

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

当用户询问销售指标时，claude 只会读取 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 时，claude 只会读取 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)

只有当用户需要这些功能时，Claude 才会读取 REDLINEING.md 或 OOXML.md。 重要准则：

  • 避免使用深度嵌套的引用——所有引用都应仅从 SKILL.md 文件向下嵌套一层。所有引用文件都应直接链接到 SKILL.md 文件。
  • 组织较长的参考文件- 对于超过 100 行的文件，请在顶部添加目录，以便 Claude 在预览时可以看到完整的内容。

技能创造过程

技能培养包括以下步骤：

  1. 通过具体例子理解这项技能
  2. 规划可重用的技能内容（脚本、参考资料、素材）
  3. 初始化技能（运行 init_skill.py）
  4. 编辑技能（添加资源并编写 SKILL.md 文件）
  5. 将技能打包（运行 package_skill.py）
  6. 根据实际使用情况迭代

请按顺序执行以下步骤，只有在有明确理由说明这些步骤不适用时才可跳过。

第一步：通过具体例子理解技能

只有当技能的使用模式已被完全理解时，才可跳过此步骤。即使是使用已有的技能，此步骤仍然很有价值。

要培养一项有效的技能，必须清楚地了解这项技能的具体应用实例。这种理解可以来自用户的直接反馈，也可以来自用户生成并经用户反馈验证的实例。

例如，在培养图像编辑技能时，相关问题包括：

  • “图像编辑器技能应该支持哪些功能？编辑、旋转，还是其他功能？”
  • “你能举例说明一下这项技能会如何运用吗？”
  • “我可以想象用户会要求‘去除图片中的红眼’或‘旋转这张图片’之类的操作。您认为这项技能还有其他用途吗？”
  • 用户说出什么话才能触发这项功能？

为了避免给用户造成信息过载，请避免在一条消息中提出过多问题。先提出最重要的问题，然后根据需要进行跟进，以提高效率。

当对该技能应支持的功能有了清晰的认识后，即可完成此步骤。

步骤二：规划可复用技能内容

要将具体例子转化为有效的技能，请按以下方式分析每个例子：

  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：编辑技能

编辑（新建或已有的）技能时，请记住该技能是为另一个 claude 实例创建的。请添加对 claude 有益且不易察觉的信息。考虑哪些程序性知识、领域特定细节或可重用资源能够帮助另一个 claude 实例更有效地执行这些任务。

学习经过验证的设计模式

根据您的技能需求，参考以下实用指南：

  • 多步骤流程：有关顺序工作流和条件逻辑，请参阅 references/workflows.md。
  • 具体输出格式或质量标准：请参阅 references/output-patterns.md 获取模板和示例模式

这些文件包含了有效技能设计的成熟最佳实践。

从可重复使用的技能内容开始

要开始实施，请从上面列出的可重用资源入手：scripts/、references/和assets/文件。请注意，此步骤可能需要用户输入。例如，在实施一项brand-guidelines技能时，用户可能需要提供品牌资产或模板以存储在assets/，或者提供文档以存储在references/。

新增的脚本必须通过实际运行进行测试，以确保没有错误且输出结果符合预期。如果有很多类似的脚本，只需测试一个具有代表性的样本，以确保所有脚本都能正常运行，同时兼顾完成时间。

任何技能学习过程中不需要的示例文件和目录都应删除。初始化脚本会在 <example_file>、<example_file>``scripts/和references/`` <example_file> 中创建示例文件assets/以演示结构，但大多数技能学习过程并不需要所有这些文件。

更新 SKILL.md

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

前言

name使用以下方式编写 YAML frontmatter description：

  • name技能名称

  • description这是你技能的主要触发机制，可以帮助 claude 了解何时使用该技能。

    • 包括技能的功能以及使用该技能的具体触发条件/情境。
    • 所有“何时使用”的信息都应包含在此处——不要放在技能正文中。技能正文只有在技能触发后才会加载，因此技能正文中的“何时使用此技能”部分对 claude 没有帮助。
    • 技能描述示例docx：“全面支持文档创建、编辑和分析，包括跟踪更改、注释、格式保留和文本提取。当 claude 需要处理专业文档（.docx 文件）时，可以使用此功能，具体包括：(1) 创建新文档；(2) 修改或编辑内容；(3) 使用跟踪更改；(4) 添加注释；或执行任何其他文档任务。”

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

正文

编写使用该技能及其配套资源的说明。

第五步：包装技能

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

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

可选的输出目录规范：

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

打包脚本将：

  1. 自动验证技能，检查以下内容：

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

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

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

步骤 6：迭代

用户在测试技能后可能会提出改进建议。这种情况通常发生在刚使用完技能之后，因为他们对技能的表现有了更清晰的了解。

迭代工作流程：

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

参考

claude code skill-creator

avatar
文章
阅读
粉丝