blob: 9e0e268cac50d1c4016dc7e1dc5cddde54f594fb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
---
name: example-skill
description: This skill should be used when the user asks to "demonstrate skills", "show skill format", "create a skill template", or discusses skill development patterns. Provides a reference template for creating Claude Code plugin skills.
version: 1.0.0
---
# Example Skill
This skill demonstrates the structure and format for Claude Code plugin skills.
## Overview
Skills are model-invoked capabilities that Claude autonomously uses based on task context. Unlike commands (user-invoked) or agents (spawned by Claude), skills provide contextual guidance that Claude incorporates into its responses.
## When This Skill Applies
This skill activates when the user's request involves:
- Creating or understanding plugin skills
- Skill template or reference needs
- Skill development patterns
## Skill Structure
### Required Files
```
skills/
└── skill-name/
└── SKILL.md # Main skill definition (required)
```
### Optional Supporting Files
```
skills/
└── skill-name/
├── SKILL.md # Main skill definition
├── README.md # Additional documentation
├── references/ # Reference materials
│ └── patterns.md
├── examples/ # Example files
│ └── sample.md
└── scripts/ # Helper scripts
└── helper.sh
```
## Frontmatter Options
Skills support these frontmatter fields:
- **name** (required): Skill identifier
- **description** (required): Trigger conditions - describe when Claude should use this skill
- **version** (optional): Semantic version number
- **license** (optional): License information or reference
## Writing Effective Descriptions
The description field is crucial - it tells Claude when to invoke the skill.
**Good description patterns:**
```yaml
description: This skill should be used when the user asks to "specific phrase", "another phrase", mentions "keyword", or discusses topic-area.
```
**Include:**
- Specific trigger phrases users might say
- Keywords that indicate relevance
- Topic areas the skill covers
## Skill Content Guidelines
1. **Clear purpose**: State what the skill helps with
2. **When to use**: Define activation conditions
3. **Structured guidance**: Organize information logically
4. **Actionable instructions**: Provide concrete steps
5. **Examples**: Include practical examples when helpful
## Best Practices
- Keep skills focused on a single domain
- Write descriptions that clearly indicate when to activate
- Include reference materials in subdirectories for complex skills
- Test that the skill activates for expected queries
- Avoid overlap with other skills' trigger conditions
|