Use this skill when the goal is to make a repository easier for coding agents to understand, change, and maintain over time.
This skill turns the main ideas from OpenAI's harness-engineering article into a reusable project pattern:
AGENTS.md stays short and acts as a routerdocs/Use this skill when the user asks to:
AGENTS.md so it routes to structured docsPick the least invasive mode that still improves the repo.
overlay: Default for existing repos. Add docs/agent/ as an agent-readable overlay without rewriting existing docs.full: Use for greenfield repos or when the user explicitly wants a broader doc reorganization.For most mature repos, start with overlay.
When applying this pattern to a repo for the first time, do the following in order:
AGENTS.md, docs/, CI, and lint/test commands.overlay or full mode.AGENTS.md block and adapt command names to the repo.AGENTS.md into the generated docs.Run the bundled script from this skill directory:
python3 scripts/bootstrap_project.py --repo /path/to/repo --mode overlay
Optional flags:
--mode overlay|full--with-gc to scaffold the garbage-collection report--dry-run to preview changes--force to overwrite generated files--no-claude-link to skip the CLAUDE.md -> AGENTS.md symlinkOn first application, the scaffold normally creates or updates:
AGENTS.md with a short agent-navigation blockCLAUDE.md symlink to AGENTS.md unless disableddocs/agent/index.mddocs/agent/architecture.mddocs/agent/specs.mddocs/agent/plans.mddocs/agent/quality.mddocs/agent/reliability.mddocs/agent/security.mdscripts/agent_repo_check.pydocs/agent/garbage-collection.mdscripts/agent_gc_report.pyAGENTS.md is a routerDo not turn AGENTS.md into a giant handbook.
AGENTS.md for task-routing instructions and repo-specific operational constraintsPut medium- and long-lived repo knowledge in docs/agent/ or the repo's main docs tree.
Examples:
Only read the docs needed for the task.
docs/agent/index.mdPrefer checks that can fail fast in CI or local validation:
AGENTS.md missing navigation linksEnable the GC loop when the repo has high change velocity, many generated edits, or recurring drift.
The default GC report looks for:
final-final or v2TODO or FIXME clustersreferences/bootstrap-playbook.md when planning the first rollout for a repo.references/docs-blueprint.md when adapting the doc taxonomy or frontmatter.references/quality-gates.md when wiring checks into CI or repo-native tooling.references/garbage-collection.md when enabling scheduled cleanup or review loops.Before you finish a rollout, confirm:
AGENTS.md routes to docs instead of duplicating themdocs/agent/index.md points to every active leaf doclast_reviewed datesscripts/agent_repo_check.py passesAGENTS.md and docs/agent/*共 1 个版本