skill-creator
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseSkill Creator
Skill 创建器
This skill provides guidance for creating effective skills.
本Skill为创建有效Skill提供指导。
About Skills
关于Skill
Skills are modular, self-contained packages that extend agent capabilities by providing
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
domains or tasks—they transform a general-purpose agent into a specialized agent
equipped with procedural knowledge and domain expertise.
Skill是模块化、独立的包,通过提供专业知识、工作流和工具来扩展Agent的能力。可以将它们视为特定领域或任务的“入门指南”——它们能将通用Agent转变为具备流程知识和领域专业能力的专用Agent。
Skill Location for Deepagents
Deepagents中的Skill存储位置
In deepagents CLI, skills are stored in where is your agent configuration name (default is ). For example, with the default configuration, skills live at:
~/.deepagents/<agent>/skills/<agent>agent~/.deepagents/agent/skills/
├── skill-name-1/
│ └── SKILL.md
├── skill-name-2/
│ └── SKILL.md
└── ...在deepagents CLI中,Skill存储在目录下,其中是你的Agent配置名称(默认是)。例如,使用默认配置时,Skill的存储路径为:
~/.deepagents/<agent>/skills/<agent>agent~/.deepagents/agent/skills/
├── skill-name-1/
│ └── SKILL.md
├── skill-name-2/
│ └── SKILL.md
└── ...What Skills Provide
Skill能提供什么
- Specialized workflows - Multi-step procedures for specific domains
- Tool integrations - Instructions for working with specific file formats or APIs
- Domain expertise - Company-specific knowledge, schemas, business logic
- Bundled resources - Scripts, references, and assets for complex and repetitive tasks
- 专业工作流 - 特定领域的多步骤流程
- 工具集成 - 处理特定文件格式或API的操作说明
- 领域专业知识 - 公司专属知识、 schema、业务逻辑
- 捆绑资源 - 用于复杂重复任务的脚本、参考资料和资产
Core Principles
核心原则
Concise is Key
简洁为要
The context window is a public good. Skills share the context window with everything else the agent needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
Default assumption: The agent is already very capable. Only add context the agent doesn't already have. Challenge each piece of information: "Does the agent really need this explanation?" and "Does this paragraph justify its token cost?"
Prefer concise examples over verbose explanations.
上下文窗口是公共资源。Skill会与Agent所需的其他所有内容共享上下文窗口:系统提示词、对话历史、其他Skill的元数据以及实际用户请求。
默认假设:Agent本身已经具备很强的能力。 仅添加Agent原本不具备的上下文信息。对每条信息都要提出质疑:“Agent真的需要这个解释吗?”以及“这段内容的token成本是否合理?”
优先使用简洁示例而非冗长解释。
Set Appropriate Degrees of Freedom
设置合适的自由度
Match the level of specificity to the task's fragility and variability:
High freedom (text-based instructions): Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
Medium freedom (pseudocode or scripts with parameters): Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
Low freedom (specific scripts, few parameters): Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
Think of the agent as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
根据任务的脆弱性和可变性匹配具体程度:
高自由度(基于文本的指令):适用于存在多种有效方法、决策依赖上下文或启发式方法指导流程的场景。
中等自由度(带参数的伪代码或脚本):适用于存在首选模式、允许一定变化或配置会影响行为的场景。
低自由度(特定脚本,参数极少):适用于操作脆弱易出错、一致性至关重要或必须遵循特定步骤的场景。
可以把Agent想象成在探索路径:两侧是悬崖的狭窄桥梁需要特定的护栏(低自由度),而开阔的场地则允许多种路线(高自由度)。
Anatomy of a Skill
Skill的结构
Every skill consists of a required SKILL.md file and optional bundled resources:
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都包含一个必填的SKILL.md文件和可选的捆绑资源:
skill-name/
├── SKILL.md (必填)
│ ├── YAML前置元数据 (必填)
│ │ ├── name: (必填)
│ │ └── description: (必填)
│ └── Markdown说明 (必填)
└── 捆绑资源 (可选)
├── scripts/ - 可执行代码(Python/Bash等)
├── references/ - 可根据需要加载到上下文中的文档
└── assets/ - 输出中使用的文件(模板、图标、字体等)SKILL.md (required)
SKILL.md(必填)
Every SKILL.md consists of:
- Frontmatter (YAML): Contains and
namefields. These are the only fields that the agent reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.description - Body (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
每个SKILL.md都包含:
- 前置元数据(YAML):包含和
name字段。Agent会读取这两个字段来决定何时使用该Skill,因此清晰全面地描述Skill的功能和适用场景非常重要。description - 正文(Markdown):使用Skill的说明和指导。仅在Skill被触发后才会加载(如果需要的话)。
Bundled Resources (optional)
捆绑资源(可选)
Scripts (scripts/
)
scripts/脚本(scripts/
)
scripts/Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
- When to include: When the same code is being rewritten repeatedly or deterministic reliability is needed
- Example: for PDF rotation tasks
scripts/rotate_pdf.py - Benefits: Token efficient, deterministic, may be executed without loading into context
- Note: Scripts may still need to be read by the agent for patching or environment-specific adjustments
用于需要确定性可靠性或反复编写的任务的可执行代码(Python/Bash等)。
- 适用场景:当相同代码被反复编写或需要确定性可靠性时
- 示例:用于PDF旋转任务的
scripts/rotate_pdf.py - 优势:Token效率高、结果确定,无需加载到上下文中即可执行
- 注意:Agent可能仍需要读取脚本以进行补丁或针对环境调整
References (references/
)
references/参考资料(references/
)
references/Documentation and reference material intended to be loaded as needed into context to inform the agent's process and thinking.
- When to include: For documentation that the agent should reference while working
- Examples: for financial schemas,
references/finance.mdfor company NDA template,references/mnda.mdfor company policies,references/policies.mdfor API specificationsreferences/api_docs.md - Use cases: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
- Benefits: Keeps SKILL.md lean, loaded only when the agent determines it's needed
- Best practice: If files are large (>10k words), include search patterns in SKILL.md
- Avoid duplication: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
用于指导Agent流程和思路的文档和参考资料,可根据需要加载到上下文中。
- 适用场景:Agent在工作中需要参考的文档
- 示例:用于财务schema的、用于公司NDA模板的
references/finance.md、用于公司政策的references/mnda.md、用于API规范的references/policies.mdreferences/api_docs.md - 使用案例:数据库schema、API文档、领域知识、公司政策、详细工作流指南
- 优势:保持SKILL.md简洁,仅在Agent判断需要时加载
- 最佳实践:如果文件过大(超过10000字),在SKILL.md中包含搜索模式
- 避免重复:信息应仅存在于SKILL.md或参考文件中,不要重复。除非是Skill的核心内容,否则优先将详细信息放在参考文件中——这样可以保持SKILL.md简洁,同时让信息可被发现且不会占用过多上下文窗口。仅在SKILL.md中保留必要的流程说明和工作流指导;将详细参考资料、schema和示例移至参考文件。
Assets (assets/
)
assets/资产(assets/
)
assets/Files not intended to be loaded into context, but rather used within the output the agent produces.
- When to include: When the skill needs files that will be used in the final output
- Examples: for brand assets,
assets/logo.pngfor PowerPoint templates,assets/slides.pptxfor HTML/React boilerplate,assets/frontend-template/for typographyassets/font.ttf - Use cases: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
- Benefits: Separates output resources from documentation, enables the agent to use files without loading them into context
无需加载到上下文中,而是用于Agent生成的输出中的文件。
- 适用场景:Skill需要用于最终输出的文件时
- 示例:用于品牌资产的、用于PowerPoint模板的
assets/logo.png、用于HTML/React模板的assets/slides.pptx、用于字体的assets/frontend-template/assets/font.ttf - 使用案例:模板、图片、图标、样板代码、字体、可复制或修改的示例文档
- 优势:将输出资源与文档分离,Agent无需将其加载到上下文即可使用
What to Not Include in a Skill
Skill中不应包含的内容
A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- etc.
The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxilary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
Skill应仅包含直接支持其功能的必要文件。请勿创建无关文档或辅助文件,包括:
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- 等
Skill应仅包含AI Agent完成当前工作所需的信息。不应包含关于Skill创建过程、设置和测试流程、面向用户的文档等辅助上下文。创建额外的文档文件只会增加混乱。
Progressive Disclosure Design Principle
渐进式披露设计原则
Skills use a three-level loading system to manage context efficiently:
- Metadata (name + description) - Always in context (~100 words)
- SKILL.md body - When skill triggers (<5k words)
- Bundled resources - As needed by the agent (Unlimited because scripts can be executed without reading into context window)
Skill采用三级加载系统来高效管理上下文:
- 元数据(名称+描述) - 始终在上下文中(约100词)
- SKILL.md正文 - Skill触发时加载(少于5000词)
- 捆绑资源 - Agent根据需要加载(无限制,因为脚本无需读取到上下文窗口即可执行)
Progressive Disclosure Patterns
渐进式披露模式
Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
Key principle: When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
Pattern 1: High-level guide with references
markdown
undefined将SKILL.md正文控制在必要内容范围内,且不超过500行,以减少上下文冗余。当内容接近此限制时,将其拆分为单独文件。将内容拆分到其他文件时,务必在SKILL.md中引用这些文件,并清晰说明何时需要读取,以确保Skill的使用者了解这些文件的存在和使用时机。
核心原则:当Skill支持多种变体、框架或选项时,仅在SKILL.md中保留核心工作流和选择指导。将变体特定的细节(模式、示例、配置)移至单独的参考文件。
模式1:带参考资料的高级指南
markdown
undefinedPDF Processing
PDF处理
Quick start
快速入门
Extract text with pdfplumber:
[code example]
使用pdfplumber提取文本:
[代码示例]
Advanced features
高级功能
- Form filling: See FORMS.md for complete guide
- API reference: See REFERENCE.md for all methods
- Examples: See EXAMPLES.md for common patterns
The agent loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
**Pattern 2: Domain-specific organization**
For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
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)
When a user asks about sales metrics, the agent only reads sales.md.
Similarly, for skills supporting multiple frameworks or variants, organize by variant:
cloud-deploy/
├── SKILL.md (workflow + provider selection)
└── references/
├── aws.md (AWS deployment patterns)
├── gcp.md (GCP deployment patterns)
└── azure.md (Azure deployment patterns)
When the user chooses AWS, the agent only reads aws.md.
**Pattern 3: Conditional details**
Show basic content, link to advanced content:
```markdown- 表单填充:完整指南请参见FORMS.md
- API参考:所有方法请参见REFERENCE.md
- 示例:常见模式请参见EXAMPLES.md
Agent仅在需要时才会加载FORMS.md、REFERENCE.md或EXAMPLES.md。
**模式2:按领域组织**
对于涉及多个领域的Skill,按领域组织内容,避免加载无关上下文:
bigquery-skill/
├── SKILL.md(概述和导航)
└── reference/
├── finance.md(收入、计费指标)
├── sales.md(销售机会、销售漏斗)
├── product.md(API使用、功能)
└── marketing.md(营销活动、归因)
当用户询问销售指标时,Agent仅会读取sales.md。
类似地,对于支持多种框架或变体的Skill,按变体组织:
cloud-deploy/
├── SKILL.md(工作流+服务商选择)
└── references/
├── aws.md(AWS部署模式)
├── gcp.md(GCP部署模式)
└── azure.md(Azure部署模式)
当用户选择AWS时,Agent仅会读取aws.md。
**模式3:条件式细节展示**
展示基础内容,链接到高级内容:
```markdownDOCX Processing
DOCX处理
Creating documents
创建文档
Use docx-js for new documents. See DOCX-JS.md.
使用docx-js创建新文档。请参见DOCX-JS.md。
Editing documents
编辑文档
For simple edits, modify the XML directly.
For tracked changes: See REDLINING.md
For OOXML details: See OOXML.md
The agent reads REDLINING.md or OOXML.md only when the user needs those features.
**Important guidelines:**
- **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
- **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so the agent can see the full scope when previewing.对于简单编辑,直接修改XML即可。
如需跟踪修订:请参见REDLINING.md
如需OOXML细节:请参见OOXML.md
Agent仅在用户需要这些功能时才会读取REDLINING.md或OOXML.md。
**重要指南**:
- **避免深层嵌套参考** - 参考文件应直接从SKILL.md链接,最多嵌套一层。所有参考文件都应直接与SKILL.md关联。
- **结构化长参考文件** - 对于超过100行的文件,在顶部添加目录,以便Agent预览时能了解完整范围。Skill Creation Process
Skill创建流程
Skill creation involves these steps:
- Understand the skill with concrete examples
- Plan reusable skill contents (scripts, references, assets)
- Initialize the skill (run init_skill.py)
- Edit the skill (implement resources and write SKILL.md)
- Validate the skill (run quick_validate.py)
- Iterate based on real usage
Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
Skill创建包含以下步骤:
- 通过具体示例理解Skill需求
- 规划可复用的Skill内容(脚本、参考资料、资产)
- 初始化Skill(运行init_skill.py)
- 编辑Skill(实现资源并编写SKILL.md)
- 验证Skill(运行quick_validate.py)
- 根据实际使用情况迭代优化
按顺序执行这些步骤,仅在有明确理由时跳过步骤。
Step 1: Understanding the Skill with Concrete Examples
步骤1:通过具体示例理解Skill需求
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
For example, when building an image-editor skill, relevant questions include:
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
- "Can you give some examples of how this skill would be used?"
- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
- "What would a user say that should trigger this skill?"
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
Conclude this step when there is a clear sense of the functionality the skill should support.
仅当Skill的使用模式已完全明确时才可跳过此步骤。即使是处理现有Skill,此步骤也很有价值。
要创建有效的Skill,需清晰了解Skill的具体使用场景。这些场景可来自直接的用户示例,或经用户反馈验证的生成示例。
例如,在构建图片编辑Skill时,相关问题包括:
- “图片编辑Skill应支持哪些功能?编辑、旋转,还是其他?”
- “能否举例说明这个Skill的使用场景?”
- “我能想到用户会要求‘去除这张图片的红眼’或‘旋转这张图片’。你认为还有其他使用场景吗?”
- “用户说什么话时应该触发这个Skill?”
为避免给用户造成负担,不要在一条消息中提出过多问题。从最重要的问题开始,根据需要跟进,以提高效率。
当明确Skill应支持的功能后,即可完成此步骤。
Step 2: Planning the Reusable Skill Contents
步骤2:规划可复用的Skill内容
To turn concrete examples into an effective skill, analyze each example by:
- Considering how to execute on the example from scratch
- Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
Example: When building a skill to handle queries like "Help me rotate this PDF," the analysis shows:
pdf-editor- Rotating a PDF requires re-writing the same code each time
- A script would be helpful to store in the skill
scripts/rotate_pdf.py
Example: When designing a skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
frontend-webapp-builder- Writing a frontend webapp requires the same boilerplate HTML/React each time
- An template containing the boilerplate HTML/React project files would be helpful to store in the skill
assets/hello-world/
Example: When building a skill to handle queries like "How many users have logged in today?" the analysis shows:
big-query- Querying BigQuery requires re-discovering the table schemas and relationships each time
- A file documenting the table schemas would be helpful to store in the skill
references/schema.md
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
要将具体示例转化为有效的Skill,需对每个示例进行分析:
- 考虑如何从头执行该示例中的任务
- 确定哪些脚本、参考资料和资产有助于重复执行这些工作流
示例:在构建处理“帮我旋转这个PDF”这类请求的Skill时,分析结果如下:
pdf-editor- 旋转PDF需要反复编写相同的代码
- 在Skill中存储脚本会很有帮助
scripts/rotate_pdf.py
示例:在构建处理“帮我构建一个待办事项应用”或“帮我构建一个跟踪步数的仪表盘”这类请求的Skill时,分析结果如下:
frontend-webapp-builder- 构建前端Web应用需要反复编写相同的HTML/React样板代码
- 在Skill中存储包含HTML/React项目样板文件的模板会很有帮助
assets/hello-world/
示例:在构建处理“今天有多少用户登录?”这类请求的Skill时,分析结果如下:
big-query- 查询BigQuery需要反复查找表schema和关系
- 在Skill中存储记录表schema的文件会很有帮助
references/schema.md
要确定Skill的内容,需分析每个具体示例,列出要包含的可复用资源:脚本、参考资料和资产。
Step 3: Initializing the Skill
步骤3:初始化Skill
At this point, it is time to actually create the skill.
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
When creating a new skill from scratch, always run the script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
init_skill.pyUsage:
bash
scripts/init_skill.py <skill-name> --path <output-directory>For deepagents CLI, use the agent's skills directory:
bash
scripts/init_skill.py <skill-name> --path ~/.deepagents/agent/skillsThe script:
- Creates the skill directory at the specified path
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
- Creates example resource directories: ,
scripts/, andreferences/assets/ - Adds example files in each directory that can be customized or deleted
After initialization, customize or remove the generated SKILL.md and example files as needed.
此时可以开始实际创建Skill了。
仅当开发的Skill已存在,且需要迭代或打包时才可跳过此步骤。这种情况下,直接进入下一步。
从头创建新Skill时,务必运行脚本。该脚本会方便地生成一个新的Skill模板目录,自动包含Skill所需的所有内容,使Skill创建过程更高效可靠。
init_skill.py使用方法:
bash
scripts/init_skill.py <skill-name> --path <output-directory>对于deepagents CLI,使用Agent的Skill目录:
bash
scripts/init_skill.py <skill-name> --path ~/.deepagents/agent/skills该脚本会:
- 在指定路径创建Skill目录
- 生成包含正确前置元数据和待办事项占位符的SKILL.md模板
- 创建示例资源目录:、
scripts/和references/assets/ - 在每个目录中添加可自定义或删除的示例文件
初始化完成后,根据需要自定义或删除生成的SKILL.md和示例文件。
Step 4: Edit the Skill
步骤4:编辑Skill
When editing the (newly-generated or existing) skill, remember that the skill is being created for an agent to use. Include information that would be beneficial and non-obvious to the agent. Consider what procedural knowledge, domain-specific details, or reusable assets would help the agent execute these tasks more effectively.
编辑(新生成或现有)Skill时,请记住,Skill是为Agent使用而创建的。包含对Agent有帮助且非显而易见的信息。考虑哪些流程知识、领域特定细节或可复用资产能帮助Agent更高效地执行任务。
Learn Proven Design Patterns
学习经过验证的设计模式
Consult these helpful guides based on your skill's needs:
- Multi-step processes: See references/workflows.md for sequential workflows and conditional logic
- Specific output formats or quality standards: See references/output-patterns.md for template and example patterns
These files contain established best practices for effective skill design.
根据Skill需求参考以下实用指南:
- 多步骤流程:请参见references/workflows.md了解顺序工作流和条件逻辑
- 特定输出格式或质量标准:请参见references/output-patterns.md了解模板和示例模式
这些文件包含有效Skill设计的既定最佳实践。
Start with Reusable Skill Contents
从可复用Skill内容开始
To begin implementation, start with the reusable resources identified above: , , and files. Note that this step may require user input. For example, when implementing a skill, the user may need to provide brand assets or templates to store in , or documentation to store in .
scripts/references/assets/brand-guidelinesassets/references/Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in , , and to demonstrate structure, but most skills won't need all of them.
scripts/references/assets/开始实现时,先处理之前确定的可复用资源:、和文件。请注意,此步骤可能需要用户输入。例如,在构建Skill时,用户可能需要提供品牌资产或模板以存储在中,或提供文档以存储在中。
scripts/references/assets/brand-guidelinesassets/references/添加的脚本必须实际运行测试,确保没有错误且输出符合预期。如果有多个类似脚本,只需测试代表性样本即可,在确保所有脚本可用的同时平衡完成时间。
删除Skill不需要的所有示例文件和目录。初始化脚本会在、和中创建示例文件以展示结构,但大多数Skill不需要所有示例文件。
scripts/references/assets/Update SKILL.md
更新SKILL.md
Writing Guidelines: Always use imperative/infinitive form.
编写指南:始终使用祈使语气/不定式形式。
Frontmatter
前置元数据
Write the YAML frontmatter with and :
namedescription- : The skill name
name - : This is the primary triggering mechanism for your skill, and helps the agent understand when to use the skill.
description- Include both what the Skill does and specific triggers/contexts for when to use it.
- Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to the agent.
- Example description for a skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when working 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"
docx
Do not include any other fields in YAML frontmatter.
编写包含和的YAML前置元数据:
namedescription- :Skill名称
name - :这是Skill的主要触发机制,帮助Agent了解何时使用该Skill。
description- 同时包含Skill的功能和具体触发场景/上下文。
- 所有“何时使用本Skill”的信息都应放在此处,而非正文中。正文仅在触发后加载,因此正文中的“何时使用本Skill”部分对Agent没有帮助。
- Skill的描述示例:“全面的文档创建、编辑和分析,支持跟踪修订、批注、格式保留和文本提取。处理专业文档(.docx文件)时使用,适用于:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理跟踪修订,(4) 添加批注,或其他任何文档相关任务”
docx
YAML前置元数据中请勿包含其他字段。
Body
正文
Write instructions for using the skill and its bundled resources.
编写使用Skill及其捆绑资源的说明。
Step 5: Validate the Skill
步骤5:验证Skill
Once development of the skill is complete, validate it to ensure it meets all requirements:
bash
scripts/quick_validate.py <path/to/skill-folder>The validation script checks:
- YAML frontmatter format and required fields
- Skill naming conventions (hyphen-case, max 64 characters)
- Description completeness (no angle brackets, max 1024 characters)
- Required fields: and
namedescription - Allowed frontmatter properties only: ,
name,description,license,allowed-toolsmetadata
If validation fails, fix the reported errors and run the validation command again.
Skill开发完成后,进行验证以确保符合所有要求:
bash
scripts/quick_validate.py <path/to/skill-folder>验证脚本会检查:
- YAML前置元数据格式和必填字段
- Skill命名规范(连字符分隔,最多64个字符)
- 描述完整性(无尖括号,最多1024个字符)
- 必填字段:和
namedescription - 仅允许的前置元数据属性:、
name、description、license、allowed-toolsmetadata
如果验证失败,修复报告的错误后重新运行验证命令。
Step 6: Iterate
步骤6:迭代优化
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
Iteration workflow:
- Use the skill on real tasks
- Notice struggles or inefficiencies
- Identify how SKILL.md or bundled resources should be updated
- Implement changes and test again
测试Skill后,用户可能会提出改进需求。通常这会发生在使用Skill后不久,用户对Skill的表现有清晰的印象。
迭代工作流:
- 在实际任务中使用Skill
- 发现问题或低效之处
- 确定应如何更新SKILL.md或捆绑资源
- 实施更改并再次测试