skills-best-practices

Solid

Opinionated best practices for building Agent Skills - SKILL.md structure, frontmatter, description writing, progressive disclosure, testing, distribution. Use when creating or reviewing a skill, or debugging why one will not trigger.

AI & Automation 36 stars 1 forks Updated today MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
52
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Skills Best Practices Opinionated guide to building Agent Skills for any agent - distilled from the [Agent Skills open standard](https://agentskills.io), Anthropic's official guidance, and production experience, with deviations from the official line marked where they occur. Skills are folders (often just a single file) containing instructions, scripts, and resources that teach an agent how to handle specific tasks. ## Quick Start A minimal skill is a directory with a `SKILL.md` file: ``` my-skill/ ├── SKILL.md # Required - instructions with YAML frontmatter ├── references/ # Optional - detailed docs loaded on demand ├── scripts/ # Optional - executable code └── assets/ # Optional - templates, fonts, icons ``` Minimal `SKILL.md`: ```yaml --- name: my-skill-name description: What it does. Use when [specific triggers]. --- # My Skill Name [Instructions here] ``` Only `name` and `description` are required in frontmatter. ## Core Design Principles ### Single File vs. references/ (Most Important) **Default to a single SKILL.md.** One file can be pasted to a person, gisted, embedded in a CLI binary, and printed by a `<tool> skill` subcommand - a directory cannot. Split into `references/` only when **both** hold: 1. **Conditional loading**: a meaningful chunk of content is needed by only a subset of invocations (e.g. a tracked-changes doc most DOCX tasks never touch). If every invocation reads everything anyway, splitting adds Read ro...

Details

Author
tenequm
Repository
tenequm/skills
Created
10 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category