agentkit / instructions
AGENTS.md2 starsChanged 3 months agoMITView on GitHub
This file defines repository-wide workflow and documentation rules. Cross-harness principles live in SYSTEM.md; more-specific AGENTS.md files add local contracts without weakening higher-priority safety or integrity requirements. For non-trivial work, use a proportionate lifecycle: Phases may loop backward when validation reveals a design or planning problem. Trivial work may collapse phases; do not add process that does not improve correctness. State assumptions. Ask only when unresolved ambiguity materially changes scope, safety, or behavior. Do not silently choose between materially different interpretations.
- Reads credentials
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository53 other files it gives its agents.
- skills/software-development/php-best-practices/AGENTS.mdAGENTS.md
- instructions/CLAUDE.mdCLAUDE.md
- architecture-designerSkill
- caveman-commitSkill
- caveman-compressSkill
- cavemanSkill
- conventional-commitSkill
- youtube-contentSkill
- agentkit-skill-authoringSkill
- skill-orchestrationSkill
- analogical-thinkingSkill
- investigateSkill
- ponytailSkill
- systematic-debuggingSkill
- mermaid-diagramsSkill
- feature-forgeSkill
- find-skillsSkill
- impeccableSkill
- javascript-proSkill
- legacy-modernizerSkill
- migrationSkill
- no-ai-slopSkill
- olakunlevpn-filament-skillsSkill
- clickupSkill
- clickup-tweak-workflowSkill
- git-advancedSkill
- local-wikiSkill
- mr-reviewSkill
- php-proSkill
- doxSkill
- improveSkill
- openspecSkill
- scrutinizeSkill
- systems-thinkingSkill
- tweakSkill
- tweak-workflowSkill
- prompt-engineerSkill
- laravel-best-practicesSkill
- pest-testingSkill
- php-best-practicesSkill
- security-audit-lightSkill
- security-best-practicesSkill
- spatie-javascriptSkill
- spatie-laravel-phpSkill
- spatie-securitySkill
- spatie-version-controlSkill
- tailwindcss-developmentSkill
- test-driven-developmentSkill
- sql-proSkill
- typescript-proSkill
- ui-ux-pro-maxSkill
- vue-expert-jsSkill
- vue-expertSkill
The file
Show its rules and text
We split this AGENTS.md into the rules it gives an agent
24 rules. About 0 are common, 20 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈20
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 28
Before architectural decisions or edits:
- Distinctive: line 30
Start at the repository root and walk to each target path.
- Distinctive: line 31
Read every applicable parent and child AGENTS.md in that path.
- Distinctive: line 32
Read nearby project documentation and relevant configuration.
- Distinctive: line 33
Treat the nearest applicable AGENTS.md as the local contract.
- Distinctive: line 35
Do not infer conventions from memory.
- Very specific: line 41
Before planning or implementing non-trivial work, use skill-orchestration when available:
- Distinctive: line 48
Do not load every domain skill or duplicate a static routing matrix.
- Distinctive: line 54
Prefer project workflows that provide:
- Distinctive: line 62
If a required feedback loop is unavailable, record that verification gap rather than treating an unobserved result as passing.
- Distinctive: line 70
add future-proofing without a demonstrated need
- Very specific: line 82
Follow SYSTEM.md → Safety and Data Integrity for every database-handling project.
- Very specific: line 86
Never run database-backed tests, seeders, or fixtures against a target loaded from local .env or another development/local environment.
- Distinctive: line 87
Before any test suite, inspect test environment selection, configuration, bootstrap/setup, fixtures, hooks, and reset behavior.
- Distinctive: line 88
Run tests only with an explicit test selector and a provably test-only, in-memory, or dedicated database.
- Very specific: line 89
Do not rely on a default environment or bare test command when it can load local .env.
- Distinctive: line 96
Before verification, identify the repository's supported commands and target environment.
- Distinctive: line 107
Do not require a test when behavior cannot be meaningfully tested.
- Distinctive: line 115
Before declaring work complete:
- Distinctive: line 118
update documentation when contracts, ownership, architecture, or workflow changed
- Distinctive: line 122
Commit, push, merge, deploy, or create an MR/PR only when explicitly requested, using the repository's approved Git workflow.
- Distinctive: line 130
Create a child AGENTS.md only when introducing a meaningful architectural boundary or persistent local convention.
- Distinctive: line 139
Avoid duplicating rules already documented higher in the hierarchy.
- Distinctive: line 143
No child AGENTS.md files are needed for the current repository structure.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
Scope
This file defines repository-wide workflow and documentation rules. Cross-harness principles live in SYSTEM.md; more-specific AGENTS.md files add local contracts without weakening higher-priority safety or integrity requirements.
Lifecycle
For non-trivial work, use a proportionate lifecycle:
- Specify — define the goal, acceptance criteria, constraints, risks, and out-of-scope work.
- Understand and route — inspect the relevant documentation, code, configuration, existing patterns, skills, and tools.
- Plan — identify affected files and symbols, state ownership, sequence changes, and choose verification checks.
- Implement — make the smallest correct change; preserve required behavior and keep the working tree focused.
- Validate — run the strongest applicable checks and inspect changed behavior and the final diff.
- Close — update affected documentation, record evidence and gaps, and summarize the result.
Phases may loop backward when validation reveals a design or planning problem. Trivial work may collapse phases; do not add process that does not improve correctness.
State assumptions. Ask only when unresolved ambiguity materially changes scope, safety, or behavior. Do not silently choose between materially different interpretations.
Repository Awareness
Before architectural decisions or edits:
- Start at the repository root and walk to each target path.
- Read every applicable parent and child
AGENTS.mdin that path. - Read nearby project documentation and relevant configuration.
- Treat the nearest applicable
AGENTS.mdas the local contract; parent documents provide broader rules.
Do not infer conventions from memory. If documentation conflicts, follow higher-priority instructions and the most specific applicable local contract.
Skill and Tool Routing
Before planning or implementing non-trivial work, use skill-orchestration when available:
- discover the current skill catalog
- select only skills with a concrete role in the task
- resolve and read selected skill instructions
- choose tools based on the actual files, behavior, and verification needs
Do not load every domain skill or duplicate a static routing matrix. If no skill matches, continue with the applicable repository instructions and tools.
Repository Legibility
Prefer project workflows that provide:
- deterministic setup and repeatable commands
- explicit dependencies, versions, and environment selection
- isolated workspaces and test targets
- structured output with actionable paths, locations, and errors
- local observability through tests, logs, dev servers, or browser automation
If a required feedback loop is unavailable, record that verification gap rather than treating an unobserved result as passing.
Minimal Changes
Implement only what the request requires. Do not:
- add future-proofing without a demonstrated need
- introduce single-use abstractions
- rewrite working code unnecessarily
- modify unrelated files
- clean up adjacent code unrelated to the outcome
Supporting tests, documentation, generated files, imports, and shared root-cause fixes are in scope when required for correctness. Minimal does not mean incomplete.
Data Safety
Follow SYSTEM.md → Safety and Data Integrity for every database-handling project.
Test Database Guardrails
- Never run database-backed tests, seeders, or fixtures against a target loaded from local
.envor another development/local environment. - Before any test suite, inspect test environment selection, configuration, bootstrap/setup, fixtures, hooks, and reset behavior.
- Run tests only with an explicit test selector and a provably test-only, in-memory, or dedicated database. The selector alone is not proof when variables or cached configuration can override the target.
- Do not rely on a default environment or bare test command when it can load local
.env. For Laravel, include--env=testingeven for filtered or targeted runs. - A testing request authorizes reset only for the verified isolated test database. Destructive operations against another database require explicit user authorization naming the operation and target.
Verification
Before verification, identify the repository's supported commands and target environment. For non-trivial work, run a baseline when practical so pre-existing failures are distinguishable from regressions.
Choose checks that match changed behavior:
- tests or focused regression tests
- linting and formatting checks
- type checking and builds
- static analysis and integration checks
- documentation/configuration parsers
- local runtime, browser, or API observation
Do not require a test when behavior cannot be meaningfully tested; use the strongest alternative and explain the gap. Never claim a check passed unless it was run and its result is known.
For refactors, preserve behavior. For bug fixes, reproduce when practical and verify the reported path. For features, verify acceptance criteria and regression risk.
Closure and Shipping
Before declaring work complete:
- inspect the final diff for scope, accidental changes, and generated artifacts
- update documentation when contracts, ownership, architecture, or workflow changed
- report changed files, verification commands/results, baseline failures, and remaining risks
- obtain required human review; automated checks do not replace human judgment
Commit, push, merge, deploy, or create an MR/PR only when explicitly requested, using the repository's approved Git workflow.
Documentation (DOX)
Documentation should evolve with architecture. Update existing documentation before creating new documentation.
Create a child AGENTS.md only when introducing a meaningful architectural boundary or persistent local convention. Child documents should describe:
- Purpose
- Ownership
- Local Contracts
- Work Guidance
- Verification
- Child Documentation Index
Avoid duplicating rules already documented higher in the hierarchy. Remove stale or contradictory text when changing a contract.
Child Documentation Index
No child AGENTS.md files are needed for the current repository structure. Root-owned files include root-level project documentation and instruction files.
Continuous Improvement
Record stable discoveries—recurring mistakes, architectural constraints, module ownership, hidden assumptions, and important conventions—in the appropriate documentation level. Keep temporary findings in the task response.
Success Signals
A healthy repository demonstrates:
- small, focused, reversible changes
- explicit ownership and consistent conventions
- deterministic workflows and repeatable verification
- accurate, current documentation
- human review at appropriate risk boundaries
- fewer repeated mistakes
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.

