invalid-description-too-long

Overview

This skill validates a skill’s description length and enforces the maximum allowed size. It specifically addresses cases like invalid-description-too-long where the description is excessively long. By catching overlong metadata, it helps maintain concise, searchable skill records.

How This Skill Works

The validator reads the SKILL.md, extracts the description field, and compares its length to the configured maximum. If the length exceeds the limit, it flags an error and returns guidance on trimming. It works as part of your lint/CI pipeline.

When to Use It

• When validating new or updated SKILL.md files to enforce length limits
• During automated linting or CI checks before publishing
• During code reviews to prevent overlong descriptions from slipping in
• During data quality audits to ensure consistent metadata
• During onboarding of new skill authors to teach length guidelines

Quick Start

1. Step 1: Run the description-length validator on SKILL.md
2. Step 2: If flagged, shorten the description to fit the limit
3. Step 3: Re-run the validator and commit changes

Best Practices

• Set a clear max length for the description (e.g., align with oneLiner under 60 chars)
• Prefer concise, outcome-focused wording in the description
• Test with edge cases: exactly at the limit and just over
• Incorporate the check into CI to catch regressions automatically
• Document the length guideline in your skill-writing style guide

Example Use Cases

• CI failure for invalid-description-too-long due to an overlong description
• Lint reports show description trimmed to fit within the allowed length
• Maintainer rewrites a verbose description into a concise summary
• New skill submission rejected until description is shortened
• Audit reveals several skills with descriptions exceeding the limit

Frequently Asked Questions