agents-md-validator

Validate AGENTS.md files for structure, commands, paths, and content quality.

1|Updated Dec 1, 2016
One-click install
npx skills add https://github.com/aaron-vaz/dotfiles --skill agents-md-validator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agents-md-validator
Source: https://github.com/aaron-vaz/dotfiles/tree/main/opencode/.opencode/skills/agents-md-validator
Command: npx skills add https://github.com/aaron-vaz/dotfiles --skill agents-md-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the tedious and error-prone process of validating AGENTS.md files, ensuring they meet completeness, accuracy, and best practice standards.

Core Features & Use Cases

  • Comprehensive Validation: Checks structure, command existence, path validity, and content quality.
  • Scoring System: Provides a quantifiable score for documentation quality.
  • Use Case: Before merging a pull request that updates documentation, run this Skill to catch any broken links, non-existent commands, or structural issues, ensuring high-quality documentation.

Quick Start

Run the agents-md-validator skill to check the AGENTS.md file in the current directory.

Frequently Asked Questions about agents-md-validator

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

FAQPage Schema
How do I validate an AGENTS.md file before merging documentation changes?

Validating an AGENTS.md file involves checking structural integrity, command executability, path accuracy, and content quality. The validator analyzes documentation against defined rules and provides a scoring metric for overall quality to ensure adherence to best practices.

What is AGENTS.md validation and why is it needed for AI agent documentation?

AGENTS.md validation is the process of checking documentation for structural integrity, command executability, path validity, and content quality. It automates catching broken links and non-existent commands, ensuring AI agent documentation meets completeness and accuracy standards.

Can I get a quantifiable score for my markdown documentation quality?

Yes, you can get a quantifiable score for markdown documentation quality. The validator provides a scoring system that evaluates AGENTS.md files against defined rules, delivering a measurable metric to track and improve overall documentation standards.

Does the AGENTS.md validator check for broken paths and non-existent commands?

Yes, the AGENTS.md validator checks for broken paths and non-existent commands. It performs comprehensive validation by verifying command executability and path accuracy, catching structural issues and ensuring documentation accuracy before merging a pull request.

What are the limitations of using automated markdown validation for agent documentation?

Automated markdown validation for agent documentation focuses strictly on structural integrity, command executability, path accuracy, and rule-based scoring. It does not replace manual review for semantic clarity or contextual accuracy of the written content.