返回 JoyAI-Echo
1 ---
2 name: skill-creator
3 description: Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
4 ---
5
6 # Skill Creator
7
8 This skill provides guidance for creating effective skills.
9
10 ## About Skills
11
12 Skills are modular, self-contained packages that extend the agent's capabilities by providing
13 specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
14 domains or tasks—they transform the agent from a general-purpose agent into a specialized agent
15 equipped with procedural knowledge that no model can fully possess.
16
17 ### What Skills Provide
18
19 1. Specialized workflows - Multi-step procedures for specific domains
20 2. Tool integrations - Instructions for working with specific file formats or APIs
21 3. Domain expertise - Company-specific knowledge, schemas, business logic
22 4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
23
24 ## Core Principles
25
26 ### Concise is Key
27
28 The context window is a public good. Skills share the context window with everything else the agent needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
29
30 **Default assumption: the agent is already very smart.** Only add context the agent doesn't already have. Challenge each piece of information: "Does the agent really need this explanation?" and "Does this paragraph justify its token cost?"
31
32 Prefer concise examples over verbose explanations.
33
34 ### Set Appropriate Degrees of Freedom
35
36 Match the level of specificity to the task's fragility and variability:
37
38 **High freedom (text-based instructions)**: Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
39
40 **Medium freedom (pseudocode or scripts with parameters)**: Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
41
42 **Low freedom (specific scripts, few parameters)**: Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
43
44 Think of the agent as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
45
46 ### Anatomy of a Skill
47
48 Every skill consists of a required SKILL.md file and optional bundled resources:
49
50 ```
51 skill-name/
52 ├── SKILL.md (required)
53 │ ├── YAML frontmatter metadata (required)
54 │ │ ├── name: (required)
55 │ │ └── description: (required)
56 │ └── Markdown instructions (required)
57 └── Bundled Resources (optional)
58 ├── scripts/ - Executable code (Python/Bash/etc.)
59 ├── references/ - Documentation intended to be loaded into context as needed
60 └── assets/ - Files used in output (templates, icons, fonts, etc.)
61 ```
62
63 #### SKILL.md (required)
64
65 Every SKILL.md consists of:
66
67 - **Frontmatter** (YAML): Contains `name` and `description` fields. These are the only fields that the agent reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.
68 - **Body** (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
69
70 #### Bundled Resources (optional)
71
72 ##### Scripts (`scripts/`)
73
74 Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
75
76 - **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
77 - **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
78 - **Benefits**: Token efficient, deterministic, may be executed without loading into context
79 - **Note**: Scripts may still need to be read by the agent for patching or environment-specific adjustments
80
81 ##### References (`references/`)
82
83 Documentation and reference material intended to be loaded as needed into context to inform the agent's process and thinking.
84
85 - **When to include**: For documentation that the 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
87 - **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
88 - **Benefits**: Keeps SKILL.md lean, loaded only when the agent determines it's needed
89 - **Best practice**: If files are large (>10k words), include grep or glob patterns in SKILL.md so the agent can use built-in search tools efficiently; mention when the default `grep(output_mode="files_with_matches")`, `grep(output_mode="count")`, `grep(fixed_strings=true)`, `glob(entry_type="dirs")`, or pagination via `head_limit` / `offset` is the right first step
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.
91
92 ##### Assets (`assets/`)
93
94 Files not intended to be loaded into context, but rather used within the output the agent produces.
95
96 - **When to include**: When the skill needs files that will be used in the final output
97 - **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
98 - **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
99 - **Benefits**: Separates output resources from documentation, enables the agent to use files without loading them into context
100
101 #### What to Not Include in a Skill
102
103 A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
104
105 - README.md
106 - INSTALLATION_GUIDE.md
107 - QUICK_REFERENCE.md
108 - CHANGELOG.md
109 - etc.
110
111 The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxiliary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
112
113 ### Progressive Disclosure Design Principle
114
115 Skills use a three-level loading system to manage context efficiently:
116
117 1. **Metadata (name + description)** - Always in context (~100 words)
118 2. **SKILL.md body** - When skill triggers (<5k words)
119 3. **Bundled resources** - As needed by the agent (Unlimited because scripts can be executed without reading into context window)
120
121 #### Progressive Disclosure Patterns
122
123 Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
124
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
127 **Pattern 1: High-level guide with references**
128
129 ```markdown
130 # PDF Processing
131
132 ## Quick start
133
134 Extract text with pdfplumber:
135 [code example]
136
137 ## Advanced features
138
139 - **Form filling**: See [FORMS.md](FORMS.md) for complete guide
140 - **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
141 - **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
142 ```
143
144 the agent loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
145
146 **Pattern 2: Domain-specific organization**
147
148 For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
149
150 ```
151 bigquery-skill/
152 ├── SKILL.md (overview and navigation)
153 └── reference/
154 ├── finance.md (revenue, billing metrics)
155 ├── sales.md (opportunities, pipeline)
156 ├── product.md (API usage, features)
157 └── marketing.md (campaigns, attribution)
158 ```
159
160 When a user asks about sales metrics, the agent only reads sales.md.
161
162 Similarly, for skills supporting multiple frameworks or variants, organize by variant:
163
164 ```
165 cloud-deploy/
166 ├── SKILL.md (workflow + provider selection)
167 └── references/
168 ├── aws.md (AWS deployment patterns)
169 ├── gcp.md (GCP deployment patterns)
170 └── azure.md (Azure deployment patterns)
171 ```
172
173 When the user chooses AWS, the agent only reads aws.md.
174
175 **Pattern 3: Conditional details**
176
177 Show basic content, link to advanced content:
178
179 ```markdown
180 # DOCX Processing
181
182 ## Creating documents
183
184 Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
185
186 ## Editing documents
187
188 For simple edits, modify the XML directly.
189
190 **For tracked changes**: See [REDLINING.md](REDLINING.md)
191 **For OOXML details**: See [OOXML.md](OOXML.md)
192 ```
193
194 the agent reads REDLINING.md or OOXML.md only when the user needs those features.
195
196 **Important guidelines:**
197
198 - **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
199 - **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so the agent can see the full scope when previewing.
200
201 ## Skill Creation Process
202
203 Skill creation involves these steps:
204
205 1. Understand the skill with concrete examples
206 2. Plan reusable skill contents (scripts, references, assets)
207 3. Initialize the skill (run init_skill.py)
208 4. Edit the skill (implement resources and write SKILL.md)
209 5. Package the skill (run package_skill.py)
210 6. Iterate based on real usage
211
212 Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
213
214 ### Skill Naming
215
216 - Use lowercase letters, digits, and hyphens only; normalize user-provided titles to hyphen-case (e.g., "Plan Mode" -> `plan-mode`).
217 - When generating names, generate a name under 64 characters (letters, digits, hyphens).
218 - Prefer short, verb-led phrases that describe the action.
219 - Namespace by tool when it improves clarity or triggering (e.g., `gh-address-comments`, `linear-address-issue`).
220 - Name the skill folder exactly after the skill name.
221
222 ### Step 1: Understanding the Skill with Concrete Examples
223
224 Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
225
226 To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
227
228 For example, when building an image-editor skill, relevant questions include:
229
230 - "What functionality should the image-editor skill support? Editing, rotating, anything else?"
231 - "Can you give some examples of how this skill would be used?"
232 - "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
233 - "What would a user say that should trigger this skill?"
234
235 To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
236
237 Conclude this step when there is a clear sense of the functionality the skill should support.
238
239 ### Step 2: Planning the Reusable Skill Contents
240
241 To turn concrete examples into an effective skill, analyze each example by:
242
243 1. Considering how to execute on the example from scratch
244 2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
245
246 Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
247
248 1. Rotating a PDF requires re-writing the same code each time
249 2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
250
251 Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
252
253 1. Writing a frontend webapp requires the same boilerplate HTML/React each time
254 2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
255
256 Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
257
258 1. Querying BigQuery requires re-discovering the table schemas and relationships each time
259 2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
260
261 To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
262
263 ### Step 3: Initializing the Skill
264
265 At this point, it is time to actually create the skill.
266
267 Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
268
269 When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
270
271 For `nanobot`, custom skills should live under the active workspace `skills/` directory so they can be discovered automatically at runtime (for example, `<workspace>/skills/my-skill/SKILL.md`).
272
273 Usage:
274
275 ```bash
276 scripts/init_skill.py <skill-name> --path <output-directory> [--resources scripts,references,assets] [--examples]
277 ```
278
279 Examples:
280
281 ```bash
282 scripts/init_skill.py my-skill --path ./workspace/skills
283 scripts/init_skill.py my-skill --path ./workspace/skills --resources scripts,references
284 scripts/init_skill.py my-skill --path ./workspace/skills --resources scripts --examples
285 ```
286
287 The script:
288
289 - Creates the skill directory at the specified path
290 - Generates a SKILL.md template with proper frontmatter and TODO placeholders
291 - Optionally creates resource directories based on `--resources`
292 - Optionally adds example files when `--examples` is set
293
294 After initialization, customize the SKILL.md and add resources as needed. If you used `--examples`, replace or delete placeholder files.
295
296 ### Step 4: Edit the Skill
297
298 When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of the agent to use. Include information that would be beneficial and non-obvious to the agent. Consider what procedural knowledge, domain-specific details, or reusable assets would help another agent instance execute these tasks more effectively.
299
300 #### Learn Proven Design Patterns
301
302 Consult these helpful guides based on your skill's needs:
303
304 - **Multi-step processes**: See references/workflows.md for sequential workflows and conditional logic
305 - **Specific output formats or quality standards**: See references/output-patterns.md for template and example patterns
306
307 These files contain established best practices for effective skill design.
308
309 #### Start with Reusable Skill Contents
310
311 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/`.
312
313 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.
314
315 If you used `--examples`, delete any placeholder files that are not needed for the skill. Only create resource directories that are actually required.
316
317 #### Update SKILL.md
318
319 **Writing Guidelines:** Always use imperative/infinitive form.
320
321 ##### Frontmatter
322
323 Write the YAML frontmatter with `name` and `description`:
324
325 - `name`: The skill name
326 - `description`: This is the primary triggering mechanism for your skill, and helps the agent understand when to use the skill.
327 - Include both what the Skill does and specific triggers/contexts for when to use it.
328 - Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to the agent.
329 - Example description for a `docx` skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when the agent needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
330
331 Keep frontmatter minimal. In `nanobot`, `metadata` and `always` are also supported when needed, but avoid adding extra fields unless they are actually required.
332
333 ##### Body
334
335 Write instructions for using the skill and its bundled resources.
336
337 ### Step 5: Packaging a Skill
338
339 Once development of the skill is complete, it must be packaged into a distributable .skill file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
340
341 ```bash
342 scripts/package_skill.py <path/to/skill-folder>
343 ```
344
345 Optional output directory specification:
346
347 ```bash
348 scripts/package_skill.py <path/to/skill-folder> ./dist
349 ```
350
351 The packaging script will:
352
353 1. **Validate** the skill automatically, checking:
354 - YAML frontmatter format and required fields
355 - Skill naming conventions and directory structure
356 - Description completeness and quality
357 - File organization and resource references
358
359 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.
360
361 Security restriction: symlinks are rejected and packaging fails when any symlink is present.
362
363 If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
364
365 ### Step 6: Iterate
366
367 After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
368
369 **Iteration workflow:**
370
371 1. Use the skill on real tasks
372 2. Notice struggles or inefficiencies
373 3. Identify how SKILL.md or bundled resources should be updated
374 4. Implement changes and test again
375
375 lines MARKDOWN