description-too-long
Scannednpx machina-cli add skill tcarac/skill-doctor/description-too-long --openclawFiles (1)
SKILL.md
1.3 KB
Test Skill - Description Too Long
This fixture tests validation of descriptions exceeding the 1024 character limit.
Source
git clone https://github.com/tcarac/skill-doctor/blob/main/tests/fixtures/edge-cases/description-too-long/SKILL.mdView on GitHub Overview
description-too-long is a test skill that validates how the system handles descriptions that exceed the maximum length. It highlights the need for strict character limits and reliable validation in content pipelines.
How This Skill Works
The SKILL.md for this fixture contains an overly long description used to trigger length validation. A validator checks the description against a 1024-character cap and surfaces an error if the limit is breached, ensuring consistent UX and data integrity.
When to Use It
- Validating user-submitted descriptions in a content management workflow
- Testing validation logic during automated content imports
- Ensuring SEO pipelines enforce character limits on skill descriptions
- Debugging UI truncation and error messaging for long inputs
- QA processes that verify length-bound constraints across APIs and UI
Quick Start
- Step 1: Detect that the provided description exceeds the 1024-character limit
- Step 2: Trim or rewrite the description to fit within the limit while preserving key meaning
- Step 3: Validate the corrected text and publish
Best Practices
- Enforce a strict 1024-character limit (or your chosen cap) and fail fast on input
- Provide clear, actionable feedback when the limit is exceeded
- Keep a short, navigable summary and offer a full text via a separate link if needed
- Store original, untrimmed descriptions in drafts or history for recovery
- Automate tests that submit overlong descriptions to guard against regressions
Example Use Cases
- Content admin panel rejects a skill description longer than 1024 characters
- API import workflow truncates or rejects long descriptions with a validation error
- SEO tooling flags long descriptions and suggests concise rewrites
- QA suite confirms consistent truncation across UI and API endpoints
- Documentation catalogs display short summaries with links to full texts
Frequently Asked Questions
Add this skill to your agents