example-skill

Demonstrate SKILL.md frontmatter structure and best practices for Claude Code skills.

1|Updated Dec 18, 2025
One-click install
npx skills add https://github.com/shawn-sandy/claude-code --skill example-skill-shawn-sandy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: example-skill
Source: https://github.com/shawn-sandy/claude-code/tree/main/plugins/starter-plugin/skills/example-skill
Command: npx skills add https://github.com/shawn-sandy/claude-code --skill example-skill-shawn-sandy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill demonstrates proper frontmatter usage, structure, and best practices for Claude Code skills, showing how to craft descriptions that include triggers and when-to-use guidance.

Core Features & Use Cases

  • Frontmatter validation: Ensures name, description, and tool restrictions are present.
  • Structure demonstration: Shows the exact SKILL.md layout including required fields.
  • Educational resource: Serves as a reference for building your own skills.

Quick Start

Copy the example in this directory to start building your own skill, and adapt the frontmatter and content to fit your use case.

Frequently Asked Questions about example-skill

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

FAQPage Schema
What is proper frontmatter structure for Claude Code skills?

Frontmatter defines metadata for Claude Code skills, including name, description, trigger patterns, and tool restrictions. This Skill demonstrates the exact SKILL.md layout with required fields like description and allowed-tools, ensuring your skill is discoverable and properly configured for the Claude Code environment.

How do I create a new Claude Code skill from a template?

Copy the example skill structure in this directory and adapt the frontmatter and content to your use case. Start by defining your skill's name, description with trigger guidance, core task, and any tool restrictions, then build out the implementation following the demonstrated best practices.

What's the difference between skills, commands, and agents in Claude Code?

Skills are reusable, task-focused plugins with frontmatter metadata and trigger descriptions; commands are single-purpose CLI operations; agents are autonomous decision-making systems. This Skill clarifies these distinctions and guides you toward choosing the right plugin type for your use case.

What required fields must I include in a skill's frontmatter?

Required frontmatter fields include name, description, and tool restrictions (allowed-tools). The description should contain trigger patterns and when-to-use guidance so Claude Code can route user requests correctly and users understand when to invoke your skill.

How do I restrict which tools a skill can access?

Define tool restrictions in the skill's frontmatter using the allowed-tools field. This pattern ensures your skill only accesses necessary tools, improving security and preventing unintended side effects when the skill is invoked.