mcpField
S
skill-creator

skill-creator

github.com/robertgussAgent 工作流13288 次安装6 周前更新
代码仓库

关于 skill-creator

skill-creator 为 Claude 提供创建技能的指导,面向编写模块化技能的开发者。内容涵盖技能结构、资源组织、上下文管理原则及创建流程。

主要功能

  1. 01技能结构与必需元数据
  2. 02脚本、参考资料和资源的组织
  3. 03渐进式披露设计原则
  4. 04技能创建与打包流程

适用场景

  1. 01为特定领域设计 Claude 技能
  2. 02决定何时将资料拆分为参考文件
  3. 03规划可复用脚本和输出模板

安装

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

$npx skills add https://github.com/robertguss/claude-code-toolkit --skill skill-creator

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

包含的文件

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

LICENSE.txt
references/
output-patterns.md
workflows.md
scripts/
init_skill.py
package_skill.py
quick_validate.py

详细介绍

技能创建器

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

关于技能

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

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

核心原则

简洁为要

上下文窗口是一种公共资源。技能要与 Claude 所需的一切内容共享上下文窗口:系统提示词、对话历史、其他技能的元数据,以及用户的实际请求。

默认假设:Claude 已经非常聪明。 只添加 Claude 尚不了解的上下文。审视每条信息:“Claude 真的需要这段解释吗?”以及“这段话值得占用这些 token 吗?”

与其冗长解释,不如优先使用简洁的示例。

设置适当的自由度

根据任务的脆弱性和可变性来匹配具体程度:

高自由度(基于文本的说明):适用于存在多种有效方法、决策取决于上下文或需要通过启发式方法指导处理的情况。

中等自由度(带参数的伪代码或脚本):适用于存在首选模式、允许一定变化或配置会影响行为的情况。

低自由度(参数较少的具体脚本):适用于操作脆弱且容易出错、一致性至关重要或必须遵循特定顺序的情况。

把 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):包含 name 和 description 字段。这是 Claude 用来判断何时使用该技能的唯一字段,因此必须清晰、全面地说明该技能的内容及适用场景。
  • 正文(Markdown):使用该技能的说明和指导。只有在技能触发后(如果触发)才会加载。
捆绑资源(可选)
脚本(scripts/)

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

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

文档和参考资料,可按需加载到上下文中,为 Claude 的处理和思考提供参考。

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

不用于加载到上下文中,而是用于 Claude 生成的输出中的文件。

  • 适用场景:技能需要在最终输出中使用文件时
  • 示例:品牌素材 assets/logo.png、PowerPoint 模板 assets/slides.pptx、HTML/React 样板文件 assets/frontend-template/、字体排版文件 assets/font.ttf
  • 使用场景:模板、图像、图标、样板代码、字体、可复制或修改的示例文档
  • 优点:将输出资源与文档分开,让 Claude 无需将文件加载到上下文中也能使用
技能中不应包含的内容

技能只应包含直接支持其功能的必要文件。请勿创建多余的文档或辅助文件,包括:

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

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

渐进式披露设计原则

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

  1. 元数据(名称 + 描述) - 始终位于上下文中(约 100 个词)
  2. SKILL.md 正文 - 技能触发时加载(<5k words)
  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。

模式 2:按领域组织

对于包含多个领域的 Skills,按领域组织内容,避免加载无关上下文:

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)

当用户询问销售指标时,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 才会读取 REDLINING.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 步:规划可复用的技能内容

要将具体示例转化为有效的技能,请逐个分析示例:

  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/ 中。

必须通过实际运行新增的脚本来测试,确保没有错误,且输出符合预期。如果有许多相似 脚本,只需测试有代表性的样本,以确信它们都能正常工作,同时兼顾完成时间。

删除技能不需要的示例文件和目录。初始化脚本会在 scripts/、references/ 和 assets/ 中创建示例文件,用于演示目录结构,但大多数技能不需要这些文件。

更新 SKILL.md

编写指南: 始终使用祈使句或不定式形式。

Frontmatter

编写包含 name 和 description 的 YAML frontmatter:

  • name:技能名称
  • description:这是技能的主要触发机制,可帮助 Claude 理解何时使用该技能。
    • 同时说明 Skill 的功能,以及适用的具体触发条件或场景。
    • 将所有“何时使用”信息都写在这里,不要写在正文中。正文仅会在触发后加载,因此在正文中添加“何时使用此技能”章节对 Claude 没有帮助。
    • docx 技能的描述示例:“全面的文档创建、编辑和分析功能,支持修订、批注、格式保留和文本提取。当 Claude 需要处理专业文档(.docx 文件)时使用,例如:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理修订,(4) 添加批注,或执行其他文档任务”

不要在 YAML frontmatter 中添加任何其他字段。

正文

编写使用此技能及其附带资源的说明。

步骤 5:打包技能

技能开发完成后,必须将其打包成可分发的 .skill 文件并分享给用户。打包过程会先自动验证技能,确保其符合所有要求:

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

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

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

打包脚本将:

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

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

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

步骤 6:迭代

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

迭代工作流:

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

评论

支持 Markdown