reviewing-agent-skill

Review SKILL.md files for YAML frontmatter, structure, and content quality.

Updated Mar 25, 2020

Search Tags:#automation #linting #validation #authoring #yaml-frontmatter #skill-review #skill-md

Ready to run

npx skills add https://github.com/daominah/gostructure --skill reviewing-agent-skill

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: reviewing-agent-skill
Source: https://github.com/daominah/gostructure/tree/main/.claude/skills/reviewing-agent-skill
Command: npx skills add https://github.com/daominah/gostructure --skill reviewing-agent-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps reviewers and authors ensure a SKILL.md adheres to established authoring best practices by identifying mechanical frontmatter errors, structure problems, and content-quality issues to make skills discoverable and reliable.

Core Features & Use Cases

Automated validation: Runs mechanical checks such as YAML frontmatter presence, name and description constraints, body length, and path sanitation via the included validation script.
Authoring guidance: Reviews metadata, description tone, structure, workflows, and script usage to recommend edits that improve clarity and trigger reliability.
Reviewer workflow: Use when performing PR reviews or editing SKILL.md files to produce a clear PASS/NEEDS_WORK verdict and actionable suggestions for re-validation.

Quick Start

Review the provided SKILL.md and produce a PASS or NEEDS_WORK verdict with Summary, Issues, and Suggestions following the review checklist.

Frequently Asked Questions about reviewing-agent-skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I validate YAML frontmatter in a SKILL.md file?▼

You can validate YAML frontmatter by running automated mechanical checks that detect metadata presence, enforce name and description constraints, and verify body length. This ensures your SKILL.md file adheres to authoring best practices and produces a clear PASS or NEEDS_WORK verdict.

What is the best way to review a SKILL.md file for authoring best practices?▼

The best way to review a SKILL.md file is to perform mechanical checks for YAML frontmatter, path hygiene, and structure, followed by content-quality evaluation. This generates a summary with issues and suggestions to improve skill discoverability and trigger reliability.

How do I check SKILL.md metadata and structure during a PR review?▼

To check SKILL.md metadata and structure during a PR review, apply a validation script that checks frontmatter, name constraints, description tone, and body length. The review yields actionable suggestions and a NEEDS_WORK or PASS verdict for re-validation.

What common frontmatter errors cause SKILL.md validation to fail?▼

Common frontmatter errors that cause SKILL.md validation to fail include missing YAML frontmatter, violating name and description constraints, exceeding body length limits, and poor path hygiene. The validation script identifies these mechanical issues for correction.

Can I use automated linting to improve SKILL.md content quality?▼

Yes, you can use automated linting to improve SKILL.md content quality by validating metadata, structure, and script usage. The review process checks description tone and path sanitation, offering structural and workflow recommendations to enhance clarity.