Skip to content

skill-creator: recommend quoting description for strict YAML parsers#964

Open
jarrieta86 wants to merge 1 commit intoanthropics:mainfrom
jarrieta86:fix/quote-skill-descriptions
Open

skill-creator: recommend quoting description for strict YAML parsers#964
jarrieta86 wants to merge 1 commit intoanthropics:mainfrom
jarrieta86:fix/quote-skill-descriptions

Conversation

@jarrieta86
Copy link
Copy Markdown

Problem

SKILL.md files authored following skill-creator often end up with an unquoted description: value containing : (e.g. Use when: ..., X: Y). Claude Code's YAML parser is lenient and accepts this, but stricter parsers (Codex CLI) reject the file with mapping values are not allowed in this context, and the skill is silently skipped at load time.

In our repo, 6 skills broke this way before we noticed, because nothing in the authoring loop surfaces the incompatibility.

Change

Add a short "Frontmatter YAML" subsection under "Anatomy of a Skill" that:

  • Notes that name / description are YAML, and parsers differ in strictness.
  • Recommends wrapping description in single quotes.
  • Shows how to escape literal apostrophes ('').

Why in skill-creator

This is the skill Claude follows when authoring new skills, so the guidance has to live here to prevent the footgun from being reintroduced by future runs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant