Agent Skills Open Standard reference (agentskills.io). Use when creating portable skills for Claude Code, Cursor, Gemini CLI, OpenAI Codex, VS Code, Roo Code, and 20+ compatible agents. Covers frontmatter schema, naming rules, directory structure, progressive disclosure, validation, and authoring. Load before creating cross-agent skills.
65
80%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
View guide
Passed
No findings from the security scan
Fix and improve this skill with Tessl
tessl review fix ./plugins/plugin-creator/skills/agentskills/SKILL.mdThe Agent Skills format is an open standard for extending AI agent capabilities with specialized knowledge and workflows. Originally developed by Anthropic, released as an open standard, and adopted by a growing number of agent products.
Source: https://agentskills.io
When to use this skill: Before creating any skill that should be portable across multiple agent products. For Claude Code-specific features (hooks, context fork, model selection, invocation control), use the plugin-creator:claude-skills-overview-2026 skill instead.
Every skill is a directory containing a SKILL.md file with YAML frontmatter and Markdown body:
skill-name/
├── SKILL.md # Required: metadata + instructions
├── scripts/ # Optional: executable code
├── references/ # Optional: documentation loaded on demand
└── assets/ # Optional: templates, images, data files---
name: skill-name
description: What this skill does and when to use it.
------
name: pdf-processing
description: Extract text and tables from PDF files, fill forms, merge documents.
license: Apache-2.0
compatibility: Requires git, docker, jq, and access to the internet
metadata:
author: example-org
version: "1.0"
allowed-tools: Bash(git:*) Bash(jq:*) Read
---| Field | Required | Max Length | Constraints |
|---|---|---|---|
name | Yes | 64 chars | Lowercase alphanumeric + hyphens. No leading/trailing/consecutive hyphens. Must match directory name. |
description | Yes | 1024 chars | Non-empty. Describe what + when to use. Include trigger keywords. |
license | No | — | License name or reference to bundled file. |
compatibility | No | 500 chars | Environment requirements (products, packages, network). |
metadata | No | — | Arbitrary string key-value pairs. |
allowed-tools | No | — | Space-delimited pre-approved tools. Experimental. |
a-z, 0-9, -)---)Valid: pdf-processing, data-analysis, code-review
Invalid: PDF-Processing (uppercase), -pdf (leading hyphen), pdf--processing (consecutive)
Write in third person. Include both what the skill does and when to use it.
# Good — specific, includes triggers
description: Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction.
# Weak — vague, no triggers
description: Helps with PDFs.Preferred patterns: Use gerund form (processing-pdfs) or noun phrases (pdf-processing). Prefer descriptive names like pdf-processing over generic names like helper or utils.
Skills use three-level loading to manage context efficiently:
name + description loaded at startup for all skillsscripts/, references/, assets/ loaded on demandKeep SKILL.md body lean. Move detailed reference material to separate files. Run uvx skilllint@latest check <skill-path> after writing and follow its guidance on token-based sizing.
Pattern 1 — High-level guide with references:
# PDF Processing
## Quick start
[core example]
## Advanced features
- **Form filling**: See [references/forms.md](references/forms.md)
- **API reference**: See [references/api.md](references/api.md)Pattern 2 — Domain-specific organization:
bigquery-skill/
├── SKILL.md (overview + navigation)
└── references/
├── finance.md
├── sales.md
└── product.mdPattern 3 — Conditional details:
For simple edits, modify XML directly.
**For tracked changes**: See [references/redlining.md](references/redlining.md)Rules:
Executable code agents can run. Should be self-contained, include helpful error messages, handle edge cases. Scripts save tokens (no code generation needed) and ensure consistency.
Make execution intent clear:
scripts/extract.py to extract fields" (execute)scripts/extract.py for the algorithm" (read as reference)Documentation loaded on demand. Keep individual files focused — smaller files mean less context usage. Structure files >100 lines with a table of contents.
Static resources used in output (templates, images, data files). Not loaded into context — used by the agent in its output.
For the complete Anthropic authoring guide, see references/best-practices.md.
Key principles:
Focus skill content on:
scripts/, references/, and assets/ for detailsPlace user-facing docs (README, CHANGELOG, INSTALLATION_GUIDE), setup procedures, and time-sensitive details in a separate "Legacy patterns" section or external docs. Claude already knows general concepts — include only skill-specific information.
For quick complexity and frontmatter checks, uvx skilllint@latest check <skill-path> is available via uvx (resolves the package from PyPI on first run — needs network access, is not bundled with this skill) and is faster than installing skills-ref.
For deeper agentskills.io open-standard compliance checks not covered by skilllint (e.g. cross-client portability rules), use the skills-ref reference library:
# Validate a skill directory
skills-ref validate ./my-skill
# Read skill properties as JSON
skills-ref read-properties ./my-skill
# Generate <available_skills> XML for agent prompts
skills-ref to-prompt ./skill-a ./skill-bPython API:
from pathlib import Path
from skills_ref import validate, read_properties, to_prompt
problems = validate(Path("my-skill"))
props = read_properties(Path("my-skill"))
prompt = to_prompt([Path("skill-a"), Path("skill-b")])Install: pip install -e . from the skills-ref directory.
Note:
skills-refis intended for demonstration purposes only and is not meant to be used in production — treat it as a reference implementation, not a hardened validation gate.
The open standard defines a portable subset. Claude Code extends it with additional frontmatter fields.
| Feature | Open Standard | Claude Code Extension |
|---|---|---|
name | Yes | Yes |
description | Yes | Yes |
license | Yes | Yes |
compatibility | Yes | Yes |
metadata | Yes | Yes |
allowed-tools | Yes (experimental) | Yes (extended syntax) |
argument-hint | No | Yes |
model | No | Yes |
context: fork | No | Yes |
agent | No | Yes |
user-invocable | No | Yes |
disable-model-invocation | No | Yes |
hooks | No | Yes |
For portable skills: Use only the open standard fields. Other agents will ignore unknown fields, but keeping frontmatter clean improves compatibility.
Claude Code-specific validation: Claude Code additionally rejects name or description values containing XML tags, and rejects name values containing the reserved words anthropic or claude — a stricter check than the open standard's own name/description rules above. This constraint is Claude Code-specific and not part of the agentskills.io specification.
For Claude Code skills: Use the plugin-creator:claude-skills-overview-2026 skill for the full extended schema.
4e1e73b
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.