skill-reviewer

Validate SKILL.md files against hard and best-practice rules and generate compliance reports.

40|21|Updated Jun 7, 2022
One-click install
npx skills add https://github.com/justeattakeaway/pie --skill skill-reviewer-justeattakeaway
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: skill-reviewer
Source: https://github.com/justeattakeaway/pie/tree/main/.agents/skills/skill-reviewer
Command: npx skills add https://github.com/justeattakeaway/pie --skill skill-reviewer-justeattakeaway

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the validation of SKILL.md files, ensuring adherence to naming conventions, frontmatter requirements, and best practices for AI skill development.

Core Features & Use Cases

  • Automated Validation: Checks for mandatory name and description in YAML frontmatter.
  • Best Practice Enforcement: Reviews content for clarity, conciseness, and adherence to defined guidelines.
  • Use Case: Before merging a new AI skill, use this reviewer to automatically generate a detailed checklist report, highlighting any issues that need to be addressed in the pull request.

Quick Start

Use the skill-reviewer skill to review the SKILL.md file located at .agents/skills/skill-reviewer/SKILL.md.

Frequently Asked Questions about skill-reviewer

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

FAQPage Schema
How do I validate SKILL.md files for AI skill compliance?

To validate SKILL.md files for AI skill compliance, use an automated reviewer to check YAML frontmatter for mandatory fields like name and description, and verify content against established best practices, generating a detailed checklist report with compliance status and actionable suggestions.

What are the required frontmatter fields for an AI skill definition?

The required frontmatter fields for an AI skill definition are mandatory name and description attributes within the YAML frontmatter. Validating these fields ensures proper skill identification and documentation before repository integration.

How do I automate AI skill review before merging a pull request?

Automate AI skill review before merging by running a validation tool against SKILL.md files to generate a detailed checklist report, highlighting compliance issues, severity levels, and actionable suggestions for frontmatter and content quality that need addressing in the pull request.

Does AI skill validation check both naming conventions and content quality?

Yes, AI skill validation checks both naming conventions and content quality. It reviews SKILL.md files against hard rules for frontmatter requirements and best-practice rules for clarity and conciseness, ensuring comprehensive documentation compliance for developers and maintainers.

What does a SKILL.md compliance report include?

A SKILL.md compliance report includes a detailed checklist of validation results, compliance status, severity levels, and actionable suggestions for both frontmatter and content quality, helping developers identify and resolve AI skill integrity issues within the repository.

When should I run an AI skill validation check?

You should run an AI skill validation check before merging a new AI skill into the repository, ensuring adherence to naming conventions, frontmatter requirements, and best practices, catching any issues that need to be addressed in the pull request early.