Skill Template
Delete this blockquote when you fork. It is a checklist for the author.
- Rename the directory to your skill's kebab-case name.
- Update
nameanddescriptionin frontmatter (description ≤1024 chars).- Fill every section below.
- Replace
scripts/example.pywith your real helper(s).- Replace
tests/test_example.pywith real happy-path + failure-path tests.- Update
requirements.txt(or switch topackage.json).- Update the per-skill
README.md.- Run
python ../../scripts/validate-skill.py .andpytest -q.
What it does
One paragraph. Be specific. Avoid marketing language.
When to use
Concrete trigger scenarios:
- When the user says "".
- When the agent is asked to .
- When working with files matching
<pattern>.
How to use
Step-by-step instructions written for the agent.
- Confirm prerequisites:
- Python 3.10+
- Environment variables:
EXAMPLE_API_KEY
- Run the main helper:
python scripts/example.py --input <path> - Interpret the output (JSON on stdout, non-zero exit on failure).
Examples
Example 1: Happy path
Input:
example input
Command:
python scripts/example.py --input example.txt
Output:
{"status": "ok", "lines": 3}
Configuration
| Env var | Required | Purpose |
|---|---|---|
EXAMPLE_API_KEY |
No | Used only when --remote is set |
Additional resources
- Deep reference: reference.md
- Human-facing summary and install: README.md