agents-md-best-practices

Refactor AGENTS.md into a minimal root file with linked category docs.

Updated Jan 17, 2026
One-click install
npx skills add https://github.com/heykvnzhao/dotfiles --skill agents-md-best-practices-heykvnzhao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agents-md-best-practices
Source: https://github.com/heykvnzhao/dotfiles/tree/main/skills/agents-md-best-practices
Command: npx skills add https://github.com/heykvnzhao/dotfiles --skill agents-md-best-practices-heykvnzhao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Refactor AGENTS.md instructions to follow progressive disclosure and AGENTS.md best practices. Use when asked to audit, reorganize, or split AGENTS.md into a minimal root file plus linked docs; includes contradiction checks, essential extraction, grouping, and deletion flags.

Core Features & Use Cases

  • Contradiction detection: Identify conflicting directives and surface them for resolution.
  • Root essentials extraction: Distill a concise one-sentence project description, non-standard build/typecheck commands, and items relevant to every task.
  • Grouping & docs structure: Cluster remaining instructions into categories and create one category file per group with actionable content.
  • Docs scaffolding: Propose a docs/agents/ structure with a minimal root AGENTS.md linking to category docs.
  • Deletion flags: Flag redundant or vague items for user confirmation before removal.

Quick Start

Provide the AGENTS.md content or path, and specify whether to apply changes or draft only.

Frequently Asked Questions about agents-md-best-practices

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

FAQPage Schema
How do I refactor AGENTS.md to use progressive disclosure?

Refactor AGENTS.md by reorganizing content into a minimal root file plus linked category docs under docs/agents/. This process applies progressive disclosure by extracting root essentials, grouping remaining instructions, and flagging deletions.

How do I detect and resolve contradictions in AGENTS.md?

Detect contradictions in AGENTS.md by auditing the file for conflicting directives before restructuring. The refactoring process surfaces these contradictions for resolution to ensure a reproducible and clean documentation output.

What is the best way to split a large AGENTS.md file into multiple documents?

Split a large AGENTS.md by clustering instructions into categories and creating one linked file per group under docs/agents/. This approach distills a concise root file with essential project descriptions and build commands while distributing detailed instructions.

How do I identify essential instructions to keep in a root AGENTS.md file?

Identify essential instructions for the root AGENTS.md by extracting a concise one-sentence project description, non-standard build or typecheck commands, and items relevant to every task. All other content is grouped into category docs.

Can I draft AGENTS.md refactoring changes without applying them immediately?

You can draft AGENTS.md refactoring changes without applying them by specifying a draft-only mode. This generates proposed templates and deletion flags for user confirmation without modifying the original files.

How are redundant or vague instructions handled during AGENTS.md audits?

Redundant or vague instructions are flagged for deletion during AGENTS.md audits. The process requires user confirmation before removing these flagged items to prevent accidental loss of potentially relevant directives.