skill-description-max-length
Skill description exceeds maximum character length
Rule Details
Long descriptions reduce readability in skill listings and menus. This rule checks the description field in SKILL.md frontmatter and reports when it exceeds the configurable maximum character count (default: 1024). Descriptions should be concise summaries; detailed documentation belongs in the body or reference files.
Incorrect
Description exceeding 1024 characters
---
name: deploy
description: This is an extremely long description that goes on and on about every detail of the deployment process including all edge cases, error handling, rollback procedures, monitoring setup, and more until it far exceeds the maximum allowed length...
---Correct
Concise description within the limit
---
name: deploy
description: Deploys the application to the specified environment with rollback support
---How To Fix
Shorten the description field to a concise summary. Move detailed information to the SKILL.md body or reference files.
Options
Default options:
{
"maxLength": 1024
}Allow up to 2048 characters:
{
"maxLength": 2048
}Enforce a strict 256-character limit:
{
"maxLength": 256
}When Not To Use It
Disable this rule if your skill requires a longer description for adequate trigger phrase coverage and you accept reduced readability in listings.
Related Rules
Resources
Version
Available since: v0.3.0