agent-description
Agent description must be at least 10 characters
Error
Rule Details
This rule enforces a minimum length on the description field in agent markdown frontmatter. The description must be at least 10 characters. Validation is delegated to the AgentFrontmatterSchema.shape.description Zod schema. Agent descriptions may include XML-style tags like <example> and <commentary> which are conventional for trigger matching.
Incorrect
Agent description that is too short
yaml
---
name: code-review
description: Reviews
---Correct
Descriptive agent description
yaml
---
name: code-review
description: Handles code reviews for pull requests and suggests improvements
---How To Fix
Write a description of at least 10 characters that clearly explains what the agent does and when it should be triggered.
Options
This rule does not have any configuration options.
Related Rules
Resources
Version
Available since: v0.2.0