agent-shell/agent-ops/skills/common/_templates/skill-template.md

51 lines
1.2 KiB
Markdown

---
name: <skill-name>
version: 1.0.0
description: <Describe in one sentence what this skill does and when to use it. Include trigger keywords when useful.>
---
# <skill-name>
## Purpose
<Explain the problem this skill solves in one or two sentences.>
## When to use
- <Invocation case 1>
- <Invocation case 2>
<!-- Optional: remove this comment and the entire Inputs section when the skill has no explicit parameters. -->
## Inputs
- `<param-name>`: <Description.> (required)
<!-- Optional: remove this comment and the entire Preflight section when no check must precede execution. -->
## Preflight
- [ ] <Condition that must be checked before execution.>
## Procedure
1. **<Step name>**
- <Required action.>
2. **Report the result**
- <Result to report.>
## Validation
- [ ] <Verifiable success condition.>
- If validation fails, <define the retry, rollback, or reporting action.>
<!-- Optional: remove this comment and the entire Output format section unless an exact shape is required. -->
## Output format
```
<Output example.>
```
<!-- Optional: remove this comment and the entire Prohibitions section unless a specific likely or unsafe action must be forbidden. -->
## Prohibitions
- <Forbidden action.>