| title | <Skill Display Name> |
| slug | skill-template |
| status | living |
| last_updated | 2025-11-01 |
| last_synced | 2025-11-01 |
| tags | catalog, skill, template |
| summary | Template for documenting skills with frontmatter, procedures, and troubleshooting. |
| authors | |
| sources | |
| name | <skill-name> |
| description | Summarize the capability provided by this skill and the inputs or situations that trigger it. |
| iface | [object Object] |
| mcp | [object Object] |
| slo | [object Object] |
| limits | [object Object] |
()
For Humans: Copy this template when documenting new skills.
For AI Agents: Populate every section with concrete details. Keep schemas and SLOs synced with the catalog.
Purpose
Explain the end-to-end outcome the skill produces and why it matters to the broader workflow.
When to Use
- List clear trigger conditions and canonical user requests.
- Note complementary skills or orchestration steps that should run before or after this one.
Prerequisites
- Describe required schemas, MCP connections, or cached context the skill expects.
- Call out configuration, policy constraints, or environment assumptions that must hold true.
Procedures
Procedure 1:
- Provide step-by-step guidance starting with input validation.
- Explain how to invoke supporting tools, databases, or prompts.
- Include decision points or fallback behaviors the agent must apply.
Procedure 2:
- Add additional flows when the skill supports multiple modes.
- Reference how to select among the procedures based on input cues.
Examples
Example 1:
- Input: resources/examples/in.json
- Process:
- Summarize each major step taken.
- Mention external dependencies invoked.
- Output: resources/examples/out.json
Add additional scenarios to capture edge cases or advanced usage as needed.
Additional Resources
resources/– Point to sample payloads, prompts, or schemas.impl/– Document helper scripts or templates included with the skill package.- Link to related policies or playbooks that influence decision making.
Troubleshooting
- Describe common validation failures and how to resolve them.
- Highlight monitoring signals to check when SLOs degrade.
- Provide escalation contacts or follow-up actions when automation cannot recover.
Update Log
- 2025-11-01: Added unified frontmatter and audience guidance to the template.