Skip to content

YAML Frontmatter

The YAML frontmatter sits between --- markers at the very top of the skill file. It contains two required fields: name and description.

---
name: analyzing-sales-data
description: Analyzes sales pipeline data and generates forecasts. Use when reviewing quarterly numbers, building projections, or identifying pipeline risks.
---
RuleRequirement
FormatKebab-case (lowercase letters, numbers, hyphens only)
StyleGerund form preferred (verb ending in -ing)
LengthMaximum 64 characters
PatternMust match ^[a-z][a-z0-9-]*$
recruiting-engineering-talent
analyzing-sales-data
reviewing-code-security
writing-technical-docs
managing-infrastructure
processing-customer-feedback
NameProblem
helperToo vague
MySkillNot kebab-case
code_reviewUnderscores, not a gerund
dataToo generic
the-ultimate-sales-methodology-v2Unnecessarily long
RuleRequirement
PersonMust be third person
ContentWhat it does AND when to use it
LengthMaximum 1,024 characters

The description gets injected into AI system prompts. First or second person creates confusion about who is speaking.

Good (third person):

description: Analyzes sales pipeline data and generates forecasts. Use when reviewing quarterly numbers, building projections, or identifying pipeline risks.

Bad (first person):

description: I analyze sales data and help you build forecasts.

Bad (second person):

description: You can use this to analyze your sales pipeline data.

The description should tell AI assistants when to activate the skill. Include “Use when…” followed by specific scenarios.

description: Reviews code for security vulnerabilities and performance issues. Use when reviewing pull requests, auditing codebases, or checking for OWASP Top 10 vulnerabilities.

This helps the AI match user requests to the right skill.

Follow this pattern: [What it does]. Use when [specific triggers].

# Pattern
description: [Verb]s [object] [how/with what]. Use when [trigger 1], [trigger 2], or [trigger 3].
# Examples
description: Writes technical documentation following the Divio framework. Use when creating API docs, writing tutorials, or structuring reference guides.
description: Manages Kubernetes deployments with rollback safety. Use when deploying to production, scaling services, or troubleshooting pod failures.
description: Conducts structured code reviews focusing on bugs and security. Use when reviewing pull requests, auditing code, or checking for vulnerabilities.

Frontmatter issues directly affect your grade under the Format Compliance criterion (15% of total score):

IssuePenalty
First/second person in description-10 points
Missing trigger phrasesScore reduced
Name not in gerund formMinor deduction
Name not kebab-caseMajor deduction
Missing frontmatter entirelyFails format compliance