agents-md:check

Audit AGENTS.md against seven documentation standards with pass/fail/warn results.

Updated May 31, 2025
One-click install
npx skills add https://github.com/dEitY719/dotfiles --skill agents-md-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agents-md:check
Source: https://github.com/dEitY719/dotfiles/tree/main/claude/skills/agents-md-check
Command: npx skills add https://github.com/dEitY719/dotfiles --skill agents-md-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit AGENTS.md for compliance with project documentation standards and quality checks. This skill guides teams to evaluate clarity, completeness, and adherence to writing standards, providing actionable improvement suggestions.

Core Features & Use Cases

  • Automated seven-criteria audit of AGENTS.md
  • Structured pass/fail/warn reporting with concrete fixes
  • Use cases include is my AGENTS.md good?, and /agents-md:check orchestration
  • Excludes non-target orchestrator files (e.g., CLAUDE.md)

Quick Start

Run the agents-md:check skill on your AGENTS.md to generate a structured compliance report.

Frequently Asked Questions about agents-md:check

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

FAQPage Schema
How do I audit my AGENTS.md file for compliance and quality?

Auditing AGENTS.md for documentation quality involves running automated checks against project standards to generate a pass, fail, or warn report with concrete improvement suggestions for clarity and completeness.

What does an AGENTS.md compliance check evaluate?

An AGENTS.md compliance check evaluates documentation quality by enforcing seven specific criteria to measure adherence to writing standards, clarity, and completeness across codebases and internal workflows.

Can I use this audit to check orchestrator files like CLAUDE.md?

No, this audit specifically targets AGENTS.md and explicitly excludes non-target orchestrator files like CLAUDE.md, ensuring the compliance and quality checks remain focused on project documentation standards.

How do I fix issues found during an AGENTS.md quality audit?

You fix issues by reviewing the structured audit report, which provides concrete improvement suggestions for each failed or warned criterion, allowing you to directly update your AGENTS.md documentation.

Does the AGENTS.md audit work for internal workflows and open-source projects?

Yes, the AGENTS.md audit applies to validating documentation quality across codebases, open-source projects, and internal workflows, evaluating compliance with project documentation standards.