starlight-skills-bp-descriptive-frontmatter

Original：🇺🇸 English

Translated

Provides rules for writing effective skill descriptions. Use this when setting up frontmatter properties for agent skill documents using starlight-skills. Do not use this for structuring the actual text body or plugin configuration options.

1installs

Sourcemew-ton/starlight-skills

Added on2026-04-05

NPX Install

npx skill4agent add mew-ton/starlight-skills starlight-skills-bp-descriptive-frontmatter

SKILL.md Content

View Translation Comparison →

The

description

field in the frontmatter is the most critical piece of metadata for your skill.

AI agents do not read the entire body of every skill in your repository to figure out what they do. Instead, the agent looks solely at the description to autonomously decide whether to load and execute that skill.

To ensure the agent discovers and uses your skill correctly, your natural language description (written in English) must clearly explain three things:

What the skill does.
When it should be triggered.
When NOT to use it (a negative trigger).

Example of a great description:

Generates descriptive commit messages by analyzing git diffs. Use this when the user asks for help writing a commit message or reviewing staged changes. Do not use this for merging branches or rebasing.

starlight-skills-bp-descriptive-frontmatter

NPX Install

Tags

SKILL.md Content