关于 skill-creator
skill-creator 为 Agent 提供创建有效技能的指导,适用于设计可复用技能包的开发者。内容涵盖技能结构、精简原则、渐进式披露和创建流程。
主要功能
- 01技能结构与文件组成
- 02按任务调整指令自由度
- 03渐进式披露设计
- 04创建与验证流程
适用场景
- 01规划技能目录及配套资源
- 02编写精简的 SKILL.md 指南
- 03为不同变体组织参考资料
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ observerw/ skill-creator-skill --skill skill-creator安装后在 Claude Code 中输入/skill-creator确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
LICENSEREADME.md.gitignorereferences/output-patterns.mdworkflows.mdscripts.mdscripts/package_skill.pyinit_skill.pyquick_validate.py详细介绍
技能创建器
此技能提供创建有效技能的指导。
关于技能
技能是模块化、自包含的软件包,通过提供专业知识、工作流和工具来扩展 Agent 的能力。可以将它们视为针对特定领域或任务的“入门指南”——它们能将 Agent 从通用助手转变为具备流程知识的专业助手,而这些知识并非任何模型都能完全掌握。
技能提供的内容
- 专业工作流 - 针对特定领域的多步骤流程
- 工具集成 - 使用特定文件格式或 API 的说明
- 领域专业知识 - 公司特定的知识、架构和业务逻辑
- 打包资源 - 用于处理复杂且重复性任务的脚本、参考资料和资产
核心原则
简洁为要
上下文窗口是一种公共资源。技能要与 Agent 所需的其他所有内容共享上下文窗口:系统提示词、对话历史、其他技能的元数据,以及用户的实际请求。
默认假设:Agent 已经非常聪明。 只添加 Agent 尚不具备的上下文。审视每一条信息:“Agent 真的需要这个解释吗?”以及“这段内容值得占用这些 token 吗?”
优先使用简洁的示例,而不是冗长的解释。
设置适当的自由度
根据任务的脆弱性和多变性,选择相应的具体程度:
- 高自由度(基于文本的说明):适用于存在多种有效方法、决策取决于上下文,或需要依据启发式方法进行指导的情况。
- 中自由度(带参数的伪代码或脚本):适用于存在首选模式、允许一定变体,或配置会影响行为的情况。
- 低自由度(参数较少的特定脚本):适用于操作脆弱且容易出错、一致性至关重要,或必须遵循特定顺序的情况。
可以把 Agent 想象成在探索一条路径:悬崖边的狭窄桥梁需要明确的防护措施(低自由度),而开阔的田野则允许多种路线(高自由度)。
技能的组成
每项技能都包含一个必需的 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):包含
name和description字段。这是 Agent 用来判断何时使用该技能的唯一字段,因此,清楚、全面地描述技能的内容和适用场景非常重要。 - 正文(Markdown):关于如何使用该技能的说明和指导。仅在技能触发后才会加载(如果会加载的话)。
打包资源(可选)
脚本(scripts/)
用于需要确定性可靠性的任务的可执行代码文件。有关在技能中创建和使用脚本的详细指导,请参阅 references/scripts.md。
参考资料(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 或参考文件中,不要两处都放。除非某些信息确实是技能的核心内容,否则详细信息优先放在参考文件中;这样既能让 SKILL.md 保持精简,又能让信息易于查找,而不占用过多上下文窗口。SKILL.md 中只保留必要的操作说明和工作流指导;将详细的参考材料、架构和示例移至参考文件。
资源(assets/)
不用于加载到上下文,而是供 Agent 在生成输出时使用的文件。
- 包含时机:技能需要在最终输出中使用文件时
- 示例:品牌资源的
assets/logo.png、PowerPoint 模板的assets/slides.pptx、HTML/React 样板代码的assets/frontend-template/、字体排版的assets/font.ttf - 使用场景:模板、图像、图标、样板代码、字体、会被复制或修改的示例文档
- 优点:将输出资源与文档分开,让 Agent 无需将文件加载到上下文中即可使用
技能中不应包含的内容
技能只应包含直接支持其功能所必需的文件。不要创建多余的文档或辅助文件,包括:
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- 等等
技能只应包含 AI Agent 完成当前任务所需的信息。不应包含关于创建过程的辅助背景、设置和测试流程、面向用户的文档等内容。创建额外的文档文件只会增加杂乱和困惑。
渐进式披露设计原则
技能采用三级加载系统,以高效管理上下文:
- 元数据(名称 + 描述) - 始终位于上下文中(约 100 个词)
- SKILL.md 正文 - 技能触发时加载(<5k 个词)
- 打包资源 - 根据 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:按领域组织
对于涵盖多个领域的 Skill,按领域组织内容,避免加载无关上下文:
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 预览时了解文件的完整范围。
Skill 创建流程
Skill 创建包含以下步骤:
- 通过具体示例了解 Skill
- 规划可复用的 Skill 内容(脚本、参考文件、资源)
- 初始化 Skill(运行 init_skill.py)
- 编辑 Skill(实现资源并编写 SKILL.md)
- 打包 Skill(运行 package_skill.py)
- 根据实际使用情况迭代
请按顺序执行这些步骤;只有在有明确理由表明某一步不适用时,才跳过该步骤。
第 1 步:通过具体示例了解 Skill
仅当 Skill 的使用模式已非常明确时,才跳过此步骤。即使是在处理现有 Skill 时,这一步仍然很有价值。
要创建有效的 Skill,应清楚了解该 Skill 的具体使用方式。这种了解可以来自用户直接提供的示例,也可以来自经过用户反馈验证的生成示例。
例如,构建图像编辑器 Skill 时,相关问题包括:
- “图像编辑器 Skill 应支持哪些功能?编辑、旋转,还是其他功能?”
- “你能举一些这个 Skill 的使用示例吗?”
- “我可以想象用户会提出诸如‘去掉这张图片中的红眼’或‘旋转这张图片’之类的请求。你还能想到其他使用方式吗?”
- “用户说什么时应该触发这个 Skill?”
为避免让用户不知所措,不要在一条消息中问太多问题。先问最重要的问题,再根据需要继续追问,以提高效果。
当你清楚了解该 Skill 应支持哪些功能时,即可结束此步骤。
第 2 步:规划可复用的技能内容
要将具体示例转化为有效的技能,请分析每个示例:
- 思考如何从头开始执行该示例
- 确定反复执行这些工作流时,哪些脚本、参考资料和资源会有所帮助
示例:创建一个用于处理“帮我旋转这个 PDF”之类请求的 pdf-editor 技能时,分析表明:
- 每次旋转 PDF 都需要重新编写相同的代码
- 将
scripts/rotate_pdf.py脚本保存在技能中会很有帮助
示例:设计一个用于处理“帮我构建一个待办事项应用”或“帮我构建一个用于追踪步数的仪表板”之类请求的 frontend-webapp-builder 技能时,分析表明:
- 每次编写前端 Web 应用都需要相同的 HTML/React 样板代码
- 将包含样板 HTML/React 项目文件的
assets/hello-world/模板保存在技能中会很有帮助
示例:创建一个用于处理“今天有多少用户登录了?”之类请求的 big-query 技能时,分析表明:
- 每次查询 BigQuery 都需要重新查找表结构和关联关系
- 将记录表结构的
references/schema.md文件保存在技能中会很有帮助
要确定技能包含的内容,请分析每个具体示例,并列出需要纳入的可复用资源:脚本、参考资料和资源。
第 3 步:初始化技能
现在可以实际创建技能了。
只有在开发的技能已经存在、且需要迭代或打包时,才跳过此步骤。在这种情况下,请继续下一步。
从头创建新技能时,务必运行 init_skill.py 脚本。该脚本可以便捷地生成新的技能模板目录,其中会自动包含技能所需的一切,从而让技能创建过程更加高效可靠。
用法:
uv run scripts/init_skill.py <skill-name> --path <output-directory>
该脚本会:
- 在指定路径创建技能目录
- 生成带有适当 frontmatter 和 TODO 占位符的 SKILL.md 模板
- 创建示例资源目录:
scripts/、references/和assets/ - 在每个目录中添加可自定义或删除的示例文件
初始化后,根据需要自定义或删除生成的 SKILL.md 和示例文件。
第 4 步:编辑技能
编辑(新生成或已有的)技能时,请记住,该技能是供另一个 Agent 实例使用的。请纳入对 Agent 有益且不显而易见的信息。考虑哪些流程知识、领域专属细节或可复用资源可以帮助另一个 Agent 实例更有效地完成这些任务。
学习经过验证的设计模式
根据技能需求,参考以下实用指南:
- 多步骤流程:参阅
references/workflows.md,了解顺序工作流和条件逻辑 - 特定输出格式或质量标准:参阅
references/output-patterns.md,了解模板和示例模式
这些文件包含设计有效技能的成熟最佳实践。
从可复用的技能内容开始
开始实现时,先使用上面确定的可复用资源:scripts/、references/ 和 assets/ 文件。请注意,此步骤可能需要用户提供输入。例如,实现 brand-guidelines 技能时,用户可能需要提供品牌素材或模板,以便存放在 assets/ 中;也可能需要提供文档,以便存放在 references/ 中。
添加的脚本必须通过实际运行进行测试,以确保没有错误,且输出符合预期。如果有许多相似脚本,只需测试其中具有代表性的样本,以确认它们都能正常运行,同时兼顾完成时间。
删除技能不需要的任何示例文件和目录。初始化脚本会在 scripts/、references/ 和 assets/ 中创建示例文件,以展示目录结构,但大多数技能并不需要这些文件。
更新 SKILL.md
编写指南: 始终使用祈使式或不定式表达。
Frontmatter
编写包含 name 和 description 的 YAML frontmatter:
name:技能名称description:这是技能的主要触发机制,可帮助 Agent 理解何时使用该技能。- 同时说明 Skill 的作用,以及应在何种具体情境下使用。
- 所有“何时使用”信息都应写在这里,不要放在正文中。正文只有在触发后才会加载,因此在正文中添加“何时使用此技能”章节对 Agent 没有帮助。
docx技能的 description 示例:“全面支持文档创建、编辑和分析,包括修订跟踪、批注、格式保留和文本提取。需要处理专业文档(.docx 文件)时使用,例如:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理修订跟踪,(4) 添加批注,或执行其他文档任务。”
不要在 YAML frontmatter 中添加其他字段。
正文
编写使用该技能及其附带资源的说明。
第 5 步:打包技能
技能开发完成后,必须将其打包为可分发的 .skill 文件,供用户获取。打包过程会先自动验证技能,确保其符合所有要求:
uv run scripts/package_skill.py <path/to/skill-folder>
可选的输出目录指定方式:
uv run scripts/package_skill.py <path/to/skill-folder> ./dist
打包脚本将:
-
验证技能,自动检查:
- YAML frontmatter 格式和必填字段
- 技能命名规范和目录结构
- Description 的完整性和质量
- 文件组织和资源引用
-
如果验证通过,则打包技能,创建一个以技能名称命名的 .skill 文件(例如
my-skill.skill),其中包含所有文件,并保留正确的目录结构以供分发。.skill 文件是扩展名为 .skill 的 zip 文件。
如果验证失败,脚本会报告错误并退出,不会创建打包文件。修复所有验证错误后,再次运行打包命令。
第 6 步:迭代
测试技能后,用户可能会提出改进要求。这种情况通常发生在用户刚使用技能之后,此时他们对技能表现的印象还很鲜明。
迭代工作流:
- 在实际任务中使用技能
- 留意遇到的困难或低效之处
- 确定应如何更新 SKILL.md 或附带资源
- 实施更改并再次测试