|
| 1 | +# Agent Skills Examples |
| 2 | + |
| 3 | +This directory contains example skills that demonstrate the Agent Skills format. |
| 4 | + |
| 5 | +## What are Agent Skills? |
| 6 | + |
| 7 | +Agent Skills are a lightweight, open format for extending AI agent capabilities with specialized knowledge and workflows. Each skill is a folder containing a `SKILL.md` file with metadata and instructions. |
| 8 | + |
| 9 | +## Skills in this directory |
| 10 | + |
| 11 | +### pdf-processing |
| 12 | + |
| 13 | +Extract text and tables from PDF files, fill PDF forms, and merge multiple PDFs. |
| 14 | + |
| 15 | +```bash |
| 16 | +coding-context -C examples/test-workspace your-task |
| 17 | +``` |
| 18 | + |
| 19 | +### data-analysis |
| 20 | + |
| 21 | +Analyze datasets, generate charts, and create summary reports for CSV, Excel, and other tabular data formats. |
| 22 | + |
| 23 | +## Skill Structure |
| 24 | + |
| 25 | +Each skill folder contains: |
| 26 | + |
| 27 | +``` |
| 28 | +skill-name/ |
| 29 | +├── SKILL.md # Required: instructions + metadata |
| 30 | +├── scripts/ # Optional: executable code |
| 31 | +├── references/ # Optional: documentation |
| 32 | +└── assets/ # Optional: templates, resources |
| 33 | +``` |
| 34 | + |
| 35 | +## Required Frontmatter |
| 36 | + |
| 37 | +The `SKILL.md` file must contain YAML frontmatter with at least: |
| 38 | + |
| 39 | +- `name`: A unique identifier (1-64 characters, lowercase alphanumeric and hyphens only) |
| 40 | +- `description`: What the skill does and when to use it (1-1024 characters) |
| 41 | + |
| 42 | +Example: |
| 43 | + |
| 44 | +```yaml |
| 45 | +--- |
| 46 | +name: pdf-processing |
| 47 | +description: Extract text and tables from PDF files, fill forms, merge documents. |
| 48 | +--- |
| 49 | +``` |
| 50 | + |
| 51 | +## Optional Frontmatter |
| 52 | + |
| 53 | +- `license`: License name or reference |
| 54 | +- `compatibility`: Environment requirements |
| 55 | +- `metadata`: Additional key-value pairs |
| 56 | +- `allowed-tools`: Pre-approved tools (experimental) |
| 57 | + |
| 58 | +## Progressive Disclosure |
| 59 | + |
| 60 | +Skills use progressive disclosure for efficient context management: |
| 61 | + |
| 62 | +1. **Discovery**: At startup, only the `name` and `description` are loaded |
| 63 | +2. **Activation**: When relevant, the agent loads the full `SKILL.md` content |
| 64 | +3. **Execution**: Scripts and resources are loaded as needed |
| 65 | + |
| 66 | +## Selectors |
| 67 | + |
| 68 | +Skills can be filtered using selectors in their frontmatter, just like rules: |
| 69 | + |
| 70 | +```yaml |
| 71 | +--- |
| 72 | +name: dev-skill |
| 73 | +description: A skill for development environments |
| 74 | +env: development |
| 75 | +--- |
| 76 | +``` |
| 77 | + |
| 78 | +Then use with: |
| 79 | + |
| 80 | +```bash |
| 81 | +coding-context -s env=development your-task |
| 82 | +``` |
| 83 | + |
| 84 | +Skills without the selector key are included by default (OR logic). |
| 85 | + |
| 86 | +## Testing |
| 87 | + |
| 88 | +To see skills in action: |
| 89 | + |
| 90 | +```bash |
| 91 | +# Navigate to the test workspace |
| 92 | +cd examples/test-workspace |
| 93 | + |
| 94 | +# Run a simple task and see discovered skills |
| 95 | +coding-context simple |
| 96 | +``` |
| 97 | + |
| 98 | +The output will include an `<available_skills>` section with skill metadata. |
0 commit comments