skill-best-practices

Enforce metadata structure and file layout for agent skills.

2.5k|134|Updated Mar 28, 2026
One-click install
npx skills add https://github.com/compozy/compozy --skill skill-best-practices-compozy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: skill-best-practices
Source: https://github.com/compozy/compozy/tree/main/.agents/skills/skill-best-practices
Command: npx skills add https://github.com/compozy/compozy --skill skill-best-practices-compozy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide codifies best-practice patterns for authoring professional-grade agent skills, ensuring consistent structure, discoverability, and validated metadata across skill units.

Core Features & Use Cases

  • Establishes a standard frontmatter schema with required fields (name and description) and optional resources directories (scripts/, references/, assets/).
  • Provides a template-driven workflow for creating new skills, including validation steps and clear guidance on progressive disclosure to keep bodies lean.
  • Serves as a reference for teams to design deterministic, safe skill pipelines and maintain quality across a growing catalog of skills.

Quick Start

Follow the steps in this guide to scaffold a new skill directory with validated metadata.

Frequently Asked Questions about skill-best-practices

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure agent skill metadata for consistent team workflows?▼

To structure agent skill metadata, use a standard frontmatter schema with required name and description fields, plus optional scripts, references, and assets directories to ensure discoverability and compliance across your team.

What's the best way to validate agent skill metadata before publishing?▼

The best way to validate agent skill metadata is by running deterministic validation scripts that enforce a consistent file layout and guard against malformed frontmatter and inconsistent naming conventions.

How do I scaffold a new agent skill directory with the correct file layout?▼

You can scaffold a new agent skill directory by following a template-driven workflow that creates validated metadata frontmatter and organizes supporting files into dedicated resource folders like scripts and references.

Why does my agent skill fail validation due to inconsistent naming?▼

Agent skill validation fails due to inconsistent naming when the metadata structure does not adhere to deterministic workflow rules, which enforce specific frontmatter schemas to prevent malformed entries.

Can I use progressive disclosure to keep my agent skill body lean?▼

Yes, you can use progressive disclosure to keep agent skill bodies lean by moving detailed logic into optional resource directories like scripts and references while maintaining standard metadata structure.