agents-md-housekeeping
Skill79 starsChanged 14 days agoMITView on GitHub
Maintain accurate, complete, retrieval-led AGENTS.md files and audit all tracked project AGENTS.md files.
In this repository41 other files it gives its agents.
- AGENTS.mdAGENTS.md
- infra/AGENTS.mdAGENTS.md
- internal/AGENTS.mdAGENTS.md
- tests/AGENTS.mdAGENTS.md
- web/AGENTS.mdAGENTS.md
- aws-crypto-goSkill
- jwx-guide-v4Skill
- simple-englishSkill
- speckit-agent-context-updateSkill
- speckit-analyzeSkill
- speckit-checklistSkill
- speckit-clarifySkill
- speckit-constitutionSkill
- speckit-convergeSkill
- speckit-git-commitSkill
- speckit-git-featureSkill
- speckit-git-initializeSkill
- speckit-git-remoteSkill
- speckit-git-validateSkill
- speckit-implementSkill
- speckit-planSkill
- speckit-specifySkill
- speckit-tasksSkill
- speckit-taskstoissuesSkill
- speckit-agent-context-updateSkill
- speckit-analyzeSkill
- speckit-checklistSkill
- speckit-clarifySkill
- speckit-constitutionSkill
- speckit-convergeSkill
- speckit-git-commitSkill
- speckit-git-featureSkill
- speckit-git-initializeSkill
- speckit-git-remoteSkill
- speckit-git-validateSkill
- speckit-implementSkill
- speckit-planSkill
- speckit-specifySkill
- speckit-tasksSkill
- speckit-taskstoissuesSkill
- agentic-workflowsSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
19 rules. About 0 are common, 18 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈18
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 11
Use this skill when the user invokes it or when a task edits an AGENTS.md file.
- Distinctive: line 17
Keep AGENTS.md files compact, factual, complete, and useful during active work.
- Distinctive: line 18
Put repository-wide rules and a compact route map in the root file.
- Distinctive: line 19
Put subtree-specific rules in the nearest useful child file.
- Distinctive: line 20
Create a child file only when the subtree has distinct rules or references.
- Distinctive: line 21
Use exact relative paths and give each important path a short purpose.
- Distinctive: line 23
Use canonical sources to prove each instruction.
- Very specific: line 24
Treat the constitution, accepted ADRs, API contracts, and ARCHITECTURE.md as canonical when they govern the changed area.
- Distinctive: line 25
Read the current feature specification, plan, and tasks when they govern the changed area.
- Distinctive: line 26
Read related project guides, configurations, runbooks, tests, and source code when they support a local instruction.
- Distinctive: line 27
Keep detailed procedures in their canonical documents.
- Distinctive: line 28
Keep each relevant canonical source reachable from the nearest useful AGENTS.md.
- Distinctive: line 29
Do not repeat a parent rule unless the child changes its scope.
- Distinctive: line 31
Remove instructions that no longer describe the repository.
- Distinctive: line 32
Write added or changed AGENTS.md text in Simplified Technical English.
- Distinctive: line 49
Do not read unrelated documents only because they exist.
- Distinctive: line 53
Update the file that owns each fact:
- Distinctive: line 61
If a new child AGENTS.md file is needed, add a route from its nearest parent.
- Distinctive: line 64
Make sure that each changed instruction:
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
AGENTS.md Housekeeping
Use this skill when the user invokes it or when a task edits an AGENTS.md
file. Do not use it only because another repository change can affect an
instruction file.
Principles
- Keep
AGENTS.mdfiles compact, factual, complete, and useful during active work. - Put repository-wide rules and a compact route map in the root file.
- Put subtree-specific rules in the nearest useful child file.
- Create a child file only when the subtree has distinct rules or references.
- Use exact relative paths and give each important path a short purpose.
- Tell agents to read source files and detailed documents before they decide.
- Use canonical sources to prove each instruction. Do not use general knowledge as evidence.
- Treat the constitution, accepted ADRs, API contracts, and
ARCHITECTURE.mdas canonical when they govern the changed area. - Read the current feature specification, plan, and tasks when they govern the changed area.
- Read related project guides, configurations, runbooks, tests, and source code when they support a local instruction.
- Keep detailed procedures in their canonical documents. Link to them instead.
- Keep each relevant canonical source reachable from the nearest useful
AGENTS.md. - Do not repeat a parent rule unless the child changes its scope.
- Preserve a useful route, rule, command, table, glossary entry, ADR index entry, or code block unless evidence shows it is obsolete.
- Remove instructions that no longer describe the repository.
- Write added or changed
AGENTS.mdtext in Simplified Technical English.
Procedure
List the project-owned instruction files:
git ls-files -- ':(glob)**/AGENTS.md' | sortBuild an evidence set for each affected
AGENTS.mdfile. Read its local source and each relevant canonical source:- Repository rules:
ARCHITECTURE.md,.specify/memory/constitution.md, and accepted ADRs. - API behavior: the relevant OpenAPI contract.
- Feature behavior: the current
spec.md,plan.md, andtasks.md. - Local behavior: source code, configuration, tests, maintained guides, and runbooks.
- Adjacent documents that the instruction file already routes to.
Do not read unrelated documents only because they exist. Read enough evidence to prove each retained, changed, or removed instruction.
- Repository rules:
- Identify facts that changed or required guidance that is missing:
Update the file that owns each fact:
Fact File Repository-wide rule Root AGENTS.mdSubtree-specific rule That subtree's AGENTS.mdDetailed design or procedure Its canonical document, linked from AGENTS.md- If a new child
AGENTS.mdfile is needed, add a route from its nearest parent. The root file must route to every important project area. - Make sure that each changed instruction:
- Its facts match the canonical source.
- Its paths, links, and commands exist.
- Its source routes cover the relevant architecture, principles, ADRs, contracts, specifications, and local guides.
- It adds local guidance instead of copying parent guidance.
- It links to detail instead of duplicating it.
- It preserves required rules, indexes, glossary entries, tables, commands, and code blocks unless they are obsolete.
- It does not describe generated or dependency files.
- Review the final diff. Make sure that each deletion has evidence. If no instruction needs a change, make no edit.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

