warning-example
Scannednpx machina-cli add skill intent-solutions-io/create-agent-skill-md/warning-skill --openclawFiles (1)
SKILL.md
401 B
Warning Example
This skill passes baseline validation but has quality warnings:
- Description starts with "I" (not third person)
- No "Use when" pattern in description
- Missing ## Instructions section
- Missing ## Examples section
It should validate with warnings but not errors.
Source
git clone https://github.com/intent-solutions-io/create-agent-skill-md/blob/main/examples/warning-skill/SKILL.mdView on GitHub Overview
Warning-example passes baseline validation but emits quality warnings. It flags issues such as a first-person description, missing Use when patterns, and absent Instructions and Examples sections, illustrating why complete, well-structured SKILLs matter.
How This Skill Works
The content is structurally valid and passes baseline checks, but the validator flags non-critical quality issues as warnings. It specifically notes the description starting with 'I', absence of a Use when pattern, and missing Instructions and Examples sections, producing warnings without blocking validation.
When to Use It
- During a skills audit to identify quality issues in SKILL.md entries
- When reviewing descriptions for third-person consistency
- When validating the presence of Use when patterns and required sections
- During onboarding of new skill authors to teach quality gates
- When maintaining a knowledge base of skills with minimal errors
Quick Start
- Step 1: Run the baseline SKILL.md validator on the skill
- Step 2: Review the generated warnings for tone, missing sections, and patterns
- Step 3: Update the description and add any missing Instructions and Examples, then re-run validation
Best Practices
- Audit descriptions for third-person tone and avoid starting with 'I'
- Ensure Use when patterns are present in descriptions
- Include clear Instructions and Examples sections
- Run baseline validation plus quality checks to catch warnings
- Document and fix warnings to improve clarity and usability
Example Use Cases
- A skills catalog flags a new entry where the description starts with 'I' and adds a revised version in third person
- QA team detects missing Instructions in a sample SKILL.md and instructs contributor to add them
- A contributor updates a warning-skill to include an Examples section
- An automated validator reports warnings but not errors for legacy skills
- Onboarding doc demonstrates resolving non-critical warnings without breaking validation
Frequently Asked Questions
Add this skill to your agents