validate-usercontext-instructions
Scannednpx machina-cli add skill MSiccDev/ai-context-kit/validate-usercontext-instructions --openclawFiles (1)
SKILL.md
2.0 KB
Validate User Context Instructions
Purpose
Validate user-context instruction files and produce deterministic reports with issues, recommendations, and a compliance score.
When To Use
- Use this skill to validate
*_usercontext.instructions.mdfiles. - Use this skill before publishing or reusing a user-context file.
- Do not use this skill for project
AGENTS.md(project context) files.
Required Inputs
- Target file path.
- Expected spec version and required sections.
- Validation strictness expectations (if any).
Workflow
- Run validation phases from
references/phase-checks.md. - Generate report using
references/report-contract.md. - Apply deterministic scoring from
references/scoring.md. - Classify findings into critical/warning/enhancement buckets.
- Produce implementation-ready recommendations.
Output Expectations
- A markdown validation report with phase-by-phase findings.
- Overall PASS/WARN/FAIL state and numeric score.
- Actionable fixes for critical and warning issues.
- Migration guidance when relevant.
- Report schema follows
references/report-contract.md. - Scoring and grade bands follow
references/scoring.md.
Resources
- Phase checks:
references/phase-checks.md - Report contract:
references/report-contract.md - Scoring model:
references/scoring.md - Example target:
../../usercontexts/sample_usercontext.instructions.md - Example report:
../../usercontexts/sample_usercontext.validation.md
Constraints And Safety
- Preserve privacy boundaries in findings and examples.
- Keep recommendations implementation-ready and non-ambiguous.
- Use provider-neutral language.
- Do not modify validated source files automatically.
Source
git clone https://github.com/MSiccDev/ai-context-kit/blob/development/skills/validate-usercontext-instructions/SKILL.mdView on GitHub Overview
Validates user-context instruction files against schema and required sections, delivering deterministic reports with issues, recommendations, and a compliance score. This helps ensure quality before publishing or reusing files.
How This Skill Works
It executes phase checks from references/phase-checks.md, generates a report using references/report-contract.md, and applies scoring from references/scoring.md. Findings are then classified into critical, warning, and enhancement buckets with actionable, implementation-ready recommendations.
When to Use It
- Validate *_usercontext.instructions.md files to ensure they conform to the target schema and sections.
- Run before publishing a new or updated user-context file to catch issues early.
- Use to prevent reuse of non-compliant user-context files across projects or agents.
- Verify alignment with the expected spec version and required sections during validation.
- Note: Do not use this skill for AGENTS.md (project context) files.
Quick Start
- Step 1: Provide the target file path, the expected spec version, and the required sections.
- Step 2: Run the validation to produce phase reports, the results, and the score.
- Step 3: Review the recommendations and apply implementation-ready fixes to the source file.
Best Practices
- Provide the exact target file path, expected spec version, and required sections as inputs.
- Run the phase checks and review phase-by-phase findings in the generated report.
- Cross-check that the score and grade bands match references/scoring.md.
- Keep findings privacy-preserving and avoid exposing sensitive data in reports.
- Do not auto-modify validated source files; implement fixes manually based on recommendations.
Example Use Cases
- A QA engineer validates a new sample_usercontext.instructions.md before release.
- An automated CI job runs this skill on a pull request to surface issues.
- A team re-validates a user-context file after schema updates to ensure compatibility.
- Governance reviews ensure the compliance score meets organizational thresholds.
- A migration scenario documents adapting an existing file to a new spec version.
Frequently Asked Questions
Add this skill to your agents