mcpField
S
skill-creator

skill-creator

github.com/jd-opensourceAgent 工作流31537 次安装28 周前更新
代码仓库

关于 skill-creator

skill-creator 指导创建可为 Claude 补充专门工作流、领域知识和资源的技能。内容涵盖技能结构、精简指令、渐进式披露,以及逐步创建和验证流程。

主要功能

  1. 01说明技能结构与元数据
  2. 02指导规划脚本、参考资料和资源文件
  3. 03精简指令的编写原则
  4. 04渐进式披露的组织方式
  5. 05创建、验证和预览步骤

适用场景

  1. 01规划可复用的领域技能
  2. 02组织参考文件与脚本
  3. 03使用前验证技能包

安装

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

$npx skills add https://github.com/jd-opensource/joysafeter --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 用于财务 schema,references/mnda.md 用于公司 NDA 模板,references/policies.md 用于公司政策,references/api_docs.md 用于 API 规范
  • 使用场景:数据库 schema、API 文档、领域知识、公司政策、详细工作流指南
  • 优势:让 SKILL.md 保持精简,仅在 Claude 判断需要时加载
  • 最佳实践:如果文件较大(>10k 词),在 SKILL.md 中包含 grep 搜索模式
  • 避免重复:信息应只存在于 SKILL.md 或 references 文件中,而不是两者都有。除非信息确实是该 skill 的核心,否则优先放在 references 文件中以承载详细信息——这样既能保持 SKILL.md 精简,又能在不占用上下文窗口的情况下让信息可被发现。SKILL.md 中只保留必要的流程说明和工作流指导;将详细的参考材料、schema 和示例移到 references 文件中。
资产(assets/)

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

  • 何时包含:当 skill 需要用于最终输出的文件时
  • 示例:assets/logo.png 用于品牌资产,assets/slides.pptx 用于 PowerPoint 模板,assets/frontend/ 用于 HTML/React 样板代码,assets/font.ttf 用于字体排版
  • 使用场景:会被复制或修改的模板、图片、图标、样板代码、字体、示例文档
  • 优势:将输出资源与文档分离,使 Claude 无需将文件加载到上下文中即可使用它们
不应包含在 Skill 中的内容

一个 skill 只应包含直接支持其功能的文件。不要创建多余的文档或辅助文件,包括:

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

skill 只应包含 AI Agent 完成手头工作所需的信息。它不应包含关于其创建过程、设置和测试步骤、面向用户的文档等辅助上下文。创建额外的文档文件只会增加杂乱和困惑。

渐进式披露设计原则

Skills 使用三级加载系统来高效管理上下文:

  1. 元数据(name + description) - 位于上下文中(约 100 词)
  2. SKILL.md 正文 - 当 skill 触发时(<5k 词)
  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:按领域组织

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

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. 验证技能(运行 quick_validate.py)
  6. 预览生成的文件(调用 preview_skill)
  7. 根据实际使用情况进行迭代

请按顺序执行这些步骤;只有在有明确理由说明不适用时,才跳过某一步。

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

只有在已经清楚了解技能的使用模式时,才跳过此步骤。即使是处理现有技能,此步骤仍然很有价值。

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

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

  • “图像编辑器技能应支持哪些功能?编辑、旋转,还是其他功能?”
  • “能否提供一些该技能的使用示例?”
  • “我可以设想用户会提出‘去除这张图片中的红眼’或‘旋转这张图片’之类的请求。你还设想过其他使用方式吗?”
  • “用户说什么时,应该触发此技能?”

为避免让用户不堪重负,不要在一条消息中提出太多问题。先提出最重要的问题,再根据需要追问,以提高效果。

当明确了解该技能应支持的功能后,即可结束此步骤。

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

要将具体示例转化为有效的技能,请通过以下方式分析每个示例:

  1. 思考如何从头开始完成该示例
  2. 找出反复执行这些工作流时会用到哪些脚本、参考资料和资源

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

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

编辑(新生成或现有的)技能时,请记住,该技能是为另一个 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 了解何时使用此技能。
    • 同时说明技能的功能,以及使用技能的具体触发条件/场景。
    • 将所有「何时使用」信息都写在这里,不要写在正文中。正文只会在触发后加载,因此在正文中添加「何时使用此技能」章节对触发时机没有帮助。
    • docx 技能的描述示例:「全面的文档创建、编辑和分析,支持修订、批注、格式保留和文本提取。当 Agent 需要处理专业文档(.docx 文件)以完成以下任务时使用:(1) 创建新文档;(2) 修改或编辑内容;(3) 处理修订;(4) 添加批注;或执行其他文档任务。」

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

正文

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

步骤 5:验证技能

在预览或保存之前运行验证器:

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

继续操作之前,先修复所有验证错误。

步骤 6:预览技能

对于 Skill Creator 产品流程,请预览生成的文件,而不是将其打包。如果技能是在 Skill Creator 沙盒中创建的,请调用:

preview_skill(skill_name="<skill-name>", skills_subdir="{thread_id}/skills")

这会生成 UI 和保存流程使用的结构化文件预览。

可选:打包技能

scripts/package_skill.py 是可选的归档辅助工具,不属于 Skill Creator 的主要工作流:

scripts/package_skill.py <path/to/skill-folder> [output-directory]

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

步骤 6:迭代

测试技能后,用户可能会要求改进。通常,他们会在刚使用完技能后提出,因为此时对技能表现的感受还很新鲜。

迭代工作流:

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

评论

支持 Markdown