example-skill

Document SKILL.md frontmatter fields and guide new skill creation.

4|Updated Jan 14, 2025
One-click install
npx skills add https://github.com/kraitsura/grimoire --skill example-skill-kraitsura
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: example-skill
Source: https://github.com/kraitsura/grimoire/tree/main/examples
Command: npx skills add https://github.com/kraitsura/grimoire --skill example-skill-kraitsura

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users understand, document, and configure Claude Skills by providing clear guidance on skill structure, manifest fields, and best practices when creating new skills.

Core Features & Use Cases

  • Documentation Guidance: Explanation of SKILL.md frontmatter fields and structure.
  • Discovery & Onboarding: Guides how discovery uses the description for skill lookup and how the frontmatter enables auto-discovery.
  • Skill Creation Templates: Provides templates and validation patterns for new skills, reducing setup time for teams.

Quick Start

Create a new skill directory, add SKILL.md with the required frontmatter, and place a concise instruction in the body that loads into the agent context when activated.

Frequently Asked Questions about example-skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a new Claude Skill with proper documentation?

Create a skill directory with a SKILL.md file containing required frontmatter fields (name and description) plus optional allowed-tools. Add concise instructions in the body that load into the agent context when activated. The description field enables auto-discovery for skill lookup.

What frontmatter fields are mandatory in SKILL.md?

SKILL.md requires two mandatory frontmatter fields: name and description. Optional fields include allowed-tools. The description field is specifically used by discovery systems to match user inquiries about skill configuration and manifest structure.

How does skill discovery work with manifest documentation?

Skill discovery uses the description field from SKILL.md frontmatter to match user inquiries. Properly structured frontmatter and clear documentation enable automatic skill lookup when users ask about configuration, manifest structure, or new skill creation.

Can I use a template to set up a new skill faster?

Yes. This Skill provides templates and validation patterns for new skills that reduce setup time. Templates include required frontmatter structure and example instruction formats that conform to the SKILL.md specification for immediate deployment.

What's the difference between required and optional frontmatter fields?

Mandatory fields (name, description) must be present in every SKILL.md. Optional fields like allowed-tools can be included when needed. The description field is critical for discovery, while allowed-tools specifies which tools the skill can invoke.

How do I migrate existing skills to the current SKILL.md format?

This Skill provides migration notes for updating skills to current SKILL.md format. Review your manifest structure against the documented frontmatter specification, add missing required fields (name, description), and restructure body content to load efficiently into agent context.