You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .agent/skills/skill-creator/SKILL.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ equipped with procedural knowledge that no model can fully possess.
19
19
1. Specialized workflows - Multi-step procedures for specific domains
20
20
2. Tool integrations - Instructions for working with specific file formats or APIs
21
21
3. Domain expertise - Company-specific knowledge, schemas, business logic
22
-
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
22
+
4. Bundled resources - Scripts, examples, and assets for complex and repetitive tasks
23
23
24
24
## Core Principles
25
25
@@ -56,7 +56,7 @@ skill-name/
56
56
│ └── Markdown instructions (required)
57
57
└── Bundled Resources (optional)
58
58
├── scripts/ - Executable code (Python/Bash/etc.)
59
-
├── references/ - Documentation intended to be loaded into context as needed
59
+
├── examples/ - Documentation intended to be loaded into context as needed
60
60
└── assets/ - Files used in output (templates, icons, fonts, etc.)
61
61
```
62
62
@@ -78,16 +78,16 @@ Executable code (Python/Bash/etc.) for tasks that require deterministic reliabil
78
78
-**Benefits**: Token efficient, deterministic, may be executed without loading into context
79
79
-**Note**: Scripts may still need to be read by Agent for patching or environment-specific adjustments
80
80
81
-
##### References (`references/`)
81
+
##### Examples (`examples/`)
82
82
83
83
Documentation and reference material intended to be loaded as needed into context to inform Agent's process and thinking.
84
84
85
85
-**When to include**: For documentation that Agent should reference while working
86
-
-**Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
86
+
-**Examples**: `examples/finance.md` for financial schemas, `examples/mnda.md` for company NDA template, `examples/policies.md` for company policies, `examples/api_docs.md` for API specifications
87
87
-**Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
88
88
-**Benefits**: Keeps SKILL.md lean, loaded only when Agent determines it's needed
89
89
-**Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
90
-
-**Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
90
+
-**Avoid duplication**: Information should live in either SKILL.md or examples files, not both. Prefer examples files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to examples files.
91
91
92
92
##### Assets (`assets/`)
93
93
@@ -124,7 +124,7 @@ Keep SKILL.md body to the essentials and under 500 lines to minimize context blo
124
124
125
125
**Key principle:** When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
126
126
127
-
**Pattern 1: High-level guide with references**
127
+
**Pattern 1: High-level guide with examples**
128
128
129
129
```markdown
130
130
# PDF Processing
@@ -150,7 +150,7 @@ For Skills with multiple domains, organize content by domain to avoid loading ir
150
150
```
151
151
bigquery-skill/
152
152
├── SKILL.md (overview and navigation)
153
-
└── reference/
153
+
└── examples/
154
154
├── finance.md (revenue, billing metrics)
155
155
├── sales.md (opportunities, pipeline)
156
156
├── product.md (API usage, features)
@@ -164,7 +164,7 @@ Similarly, for skills supporting multiple frameworks or variants, organize by va
164
164
```
165
165
cloud-deploy/
166
166
├── SKILL.md (workflow + provider selection)
167
-
└── references/
167
+
└── examples/
168
168
├── aws.md (AWS deployment patterns)
169
169
├── gcp.md (GCP deployment patterns)
170
170
└── azure.md (Azure deployment patterns)
@@ -195,15 +195,15 @@ Agent reads REDLINING.md or OOXML.md only when the user needs those features.
195
195
196
196
**Important guidelines:**
197
197
198
-
-**Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
198
+
-**Avoid deeply nested examples** - Keep examples one level deep from SKILL.md. All reference files should link directly from SKILL.md.
199
199
-**Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Agent can see the full scope when previewing.
200
200
201
201
## Skill Creation Process
202
202
203
203
Skill creation involves these steps:
204
204
205
205
1. Understand the skill with concrete examples
206
-
2. Plan reusable skill contents (scripts, references, assets)
206
+
2. Plan reusable skill contents (scripts, examples, assets)
207
207
3. Initialize the skill (run init_skill.py)
208
208
4. Edit the skill (implement resources and write SKILL.md)
209
209
5. Package the skill (run package_skill.py)
@@ -233,7 +233,7 @@ Conclude this step when there is a clear sense of the functionality the skill sh
233
233
To turn concrete examples into an effective skill, analyze each example by:
234
234
235
235
1. Considering how to execute on the example from scratch
236
-
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
236
+
2. Identifying what scripts, examples, and assets would be helpful when executing these workflows repeatedly
237
237
238
238
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
239
239
@@ -248,9 +248,9 @@ Example: When designing a `frontend-webapp-builder` skill for queries like "Buil
248
248
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
249
249
250
250
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
251
-
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
251
+
2. A `examples/schema.md` file documenting the table schemas would be helpful to store in the skill
252
252
253
-
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
253
+
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, examples, and assets.
254
254
255
255
### Step 3: Initializing the Skill
256
256
@@ -270,7 +270,7 @@ The script:
270
270
271
271
- Creates the skill directory at the specified path
272
272
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
273
-
- Creates example resource directories: `scripts/`, `references/`, and `assets/`
273
+
- Creates example resource directories: `scripts/`, `examples/`, and `assets/`
274
274
- Adds example files in each directory that can be customized or deleted
275
275
276
276
After initialization, customize or remove the generated SKILL.md and example files as needed.
@@ -283,18 +283,18 @@ When editing the (newly-generated or existing) skill, remember that the skill is
283
283
284
284
Consult these helpful guides based on your skill's needs:
285
285
286
-
-**Multi-step processes**: See references/workflows.md for sequential workflows and conditional logic
287
-
-**Specific output formats or quality standards**: See references/output-patterns.md for template and example patterns
286
+
-**Multi-step processes**: See examples/workflows.md for sequential workflows and conditional logic
287
+
-**Specific output formats or quality standards**: See examples/output-patterns.md for template and example patterns
288
288
289
289
These files contain established best practices for effective skill design.
290
290
291
291
#### Start with Reusable Skill Contents
292
292
293
-
To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
293
+
To begin implementation, start with the reusable resources identified above: `scripts/`, `examples/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `examples/`.
294
294
295
295
Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
296
296
297
-
Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
297
+
Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in `scripts/`, `examples/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
298
298
299
299
#### Update SKILL.md
300
300
@@ -337,7 +337,7 @@ The packaging script will:
337
337
- YAML frontmatter format and required fields
338
338
- Skill naming conventions and directory structure
339
339
- Description completeness and quality
340
-
- File organization and resource references
340
+
- File organization and resource examples
341
341
342
342
2.**Package** the skill if validation passes, creating a .skill file named after the skill (e.g., `my-skill.skill`) that includes all files and maintains the proper directory structure for distribution. The .skill file is a zip file with a .skill extension.
0 commit comments