agent-conventions

Validate YAML frontmatter, enforce kebab-case naming, and update README indexes for agent files.

4|1|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/wyattowalsh/agents --skill agent-conventions-wyattowalsh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agent-conventions
Source: https://github.com/wyattowalsh/agents/tree/main/skills/agent-conventions
Command: npx skills add https://github.com/wyattowalsh/agents --skill agent-conventions-wyattowalsh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill enforces consistent standards for AI agent definitions, ensuring clarity, maintainability, and discoverability across all agents.

Core Features & Use Cases

  • Frontmatter Validation: Ensures required fields like name and description are present and correctly formatted.
  • Naming Conventions: Enforces kebab-case for agent names and filenames, matching them precisely.
  • README Indexing: Guides the process of updating README.md files to include new or modified agents, keeping documentation current.
  • Use Case: When creating a new agent for API design, this skill will automatically check that its filename is api-designer.md, its name in the frontmatter is api-designer, and that it's added to the agents/README.md index.

Quick Start

Use the agent-conventions skill to validate the frontmatter of a new agent definition.

Frequently Asked Questions about agent-conventions

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

FAQPage Schema
How do I validate frontmatter for AI agent definitions?

Validate AI agent definitions by checking frontmatter for required YAML fields like name and description. This ensures agent files maintain clarity and adhere to required formatting standards automatically.

What naming conventions should I use for agent files?

Agent files require kebab-case naming conventions, ensuring the filename matches the frontmatter name field exactly. This maintains consistency and discoverability across all agents in the directory.

How do I keep a README index updated when adding new agents?

Keep a README index updated by maintaining the agents/README.md index table whenever new or modified agents are created, ensuring documentation remains current and discoverable.

Does agent-conventions enforce specific YAML fields for agent definitions?

Agent-conventions enforces specific YAML fields for agent definitions, requiring mandatory fields such as name and description to be present and correctly formatted in the frontmatter.

What happens if an agent filename does not match its frontmatter name?

If an agent filename does not match its frontmatter name, the validation fails because the skill enforces strict kebab-case naming consistency between the Markdown filename and the YAML name field.

Can I use agent-conventions for validating existing agent directories?

You can use agent-conventions for validating existing agent directories by checking frontmatter fields, enforcing kebab-case naming consistency, and updating the README.md index table.