agentleFS
healthier-vitaminshealthier-vitamins/agentic-grimoire/AGENTS.md

agentic-grimoire

AGENTS.md2 starsChanged 10 days agoMITView on GitHub

Behavioral guidelines to reduce common LLM coding mistakes. Merge with project-specific instructions as needed. Tradeoff: These guidelines bias toward caution over speed. For trivial tasks, use judgment. Shared repository rules live here: Before finishing any code task, follow: Do not finish with known safe-to-fix issues in the changed scope. Codex adds no default co-author trailer, so it attaches nothing — that is expected and correct. Do not fabricate a Co-Authored-By, session-id, or URL trailer on commit messages. Keep orchestration, planning,…

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

27 rules. About 0 are common, 21 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈21

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before finishing any code task, follow:

    line 15
  2. Distinctive:

    Do not finish with known safe-to-fix issues in the changed scope.

    line 19
  3. Very specific:

    Do not fabricate a Co-Authored-By, session-id, or URL trailer on commit messages.

    line 24
  4. Distinctive:

    Keep orchestration, planning, and review on the top model at all times — never downgrade the main agent.

    line 28
  5. Very specific:

    Read ~/.claude/skills/keystone/SKILL.md before implementing non-trivial logic, structuring a module, or judging whether existing code reads …

    line 48
  6. Distinctive:

    If multiple interpretations exist, present them - don't pick silently.

    line 60
  7. Distinctive:

    If a simpler approach exists, say so.

    line 61
  8. Distinctive:

    If something is unclear, stop.

    line 62
  9. Distinctive:

    No features beyond what was asked.

    line 68
  10. Distinctive:

    No abstractions for single-use code.

    line 69
  11. Distinctive:

    No error handling for impossible scenarios.

    line 71
  12. Distinctive:

    If you write 200 lines and it could be 50, rewrite it.

    line 72
  13. Distinctive:

    Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify.

    line 74
  14. Distinctive:

    When editing existing code:

    line 80
  15. Distinctive:

    Don't "improve" adjacent code, comments, or formatting.

    line 82
  16. Distinctive:

    Don't refactor things that aren't broken.

    line 83
  17. Distinctive:

    If you notice unrelated dead code, mention it - don't delete it.

    line 85
  18. Distinctive:

    When your changes create orphans:

    line 87
  19. Very specific:

    Remove imports/variables/functions that YOUR changes made unused.

    line 89
  20. Distinctive:

    Don't remove pre-existing dead code unless asked.

    line 90
  21. Distinctive:

    When a problem maps cleanly to a known pattern, use it — don't build a bespoke solution that a reviewer will have to reverse-engineer.

    line 118
  22. Very specific:

    Use the context7 tool when you need library or API documentation.

    line 133
  23. Very specific:

    Use the context7 tool when you need code generation, setup instructions, or configuration steps.

    line 134
  24. Distinctive:

    Do not rely on memory for library versions or APIs when verification is needed.

    line 135
  25. Distinctive:

    Prefer modern CLI search tools for efficiency:

    line 139
  26. Very specific:

    Use fd instead of find.

    line 141
  27. Distinctive:

    If either tool is missing, inform the user and ask before running an install command.

    line 144

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

Behavioral guidelines to reduce common LLM coding mistakes. Merge with project-specific instructions as needed.

Tradeoff: These guidelines bias toward caution over speed. For trivial tasks, use judgment.

Shared Rules

Shared repository rules live here:

  • ./.shared-agents/common/linting.md

Validation

Before finishing any code task, follow:

  • ./.shared-agents/common/linting.md

Do not finish with known safe-to-fix issues in the changed scope.

Commits

Codex adds no default co-author trailer, so it attaches nothing — that is expected and correct. Do not fabricate a Co-Authored-By, session-id, or URL trailer on commit messages.

Model Selection

Keep orchestration, planning, and review on the top model at all times — never downgrade the main agent. Delegate mechanical work to subagents so the orchestrator's context stays clean; the cost win comes from that isolation (and a cheaper worker model), not from starving the worker's reasoning.

Match each subagent's reasoning effort to its task — low for a simple lookup, higher for interdependent changes or debugging — and reach for more effort whenever a cheap miss would be costly to recover from (a failed worker bounces back to the orchestrator at full price). Codex only spawns subagents when asked, so treat this as a standing instruction to delegate.

Route subagents by difficulty — each agent's own model sets its cost, whatever model the main session runs:

  • research and hard analysis → researcher (GPT-6 Astra)
  • implementing an already-decided plan → executor (GPT-6.1 Sol)
  • codebase search → explorer (GPT-6 Luna)

Keystone

Read ~/.claude/skills/keystone/SKILL.md before implementing non-trivial logic, structuring a module, or judging whether existing code reads well — it carries the reading standard all code is written to. React components, pages, and features also take ~/.claude/skills/keystone-react/SKILL.md.

1. Think Before Coding

Don't assume. Don't hide confusion. Surface tradeoffs.

Before implementing:

  • State your assumptions explicitly. If uncertain, ask.
  • If multiple interpretations exist, present them - don't pick silently.
  • If a simpler approach exists, say so. Push back when warranted.
  • If something is unclear, stop. Name what's confusing. Ask.

2. Simplicity First

Minimum code that solves the problem. Nothing speculative.

  • No features beyond what was asked.
  • No abstractions for single-use code.
  • No "flexibility" or "configurability" that wasn't requested.
  • No error handling for impossible scenarios.
  • If you write 200 lines and it could be 50, rewrite it.

Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify.

3. Surgical Changes

Touch only what you must. Clean up only your own mess.

When editing existing code:

  • Don't "improve" adjacent code, comments, or formatting.
  • Don't refactor things that aren't broken.
  • Match existing style, even if you'd do it differently.
  • If you notice unrelated dead code, mention it - don't delete it.

When your changes create orphans:

  • Remove imports/variables/functions that YOUR changes made unused.
  • Don't remove pre-existing dead code unless asked.

The test: Every changed line should trace directly to the user's request.

4. Goal-Driven Execution

Define success criteria. Loop until verified.

Transform tasks into verifiable goals:

  • "Add validation" → "Write tests for invalid inputs, then make them pass"
  • "Fix the bug" → "Write a test that reproduces it, then make it pass"
  • "Refactor X" → "Ensure tests pass before and after"

For multi-step tasks, state a brief plan:

1. [Step] → verify: [check]
2. [Step] → verify: [check]
3. [Step] → verify: [check]

Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification.

5. Design Patterns

Reach for an established pattern before inventing structure.

When a problem maps cleanly to a known pattern, use it — don't build a bespoke solution that a reviewer will have to reverse-engineer.

CategoryPatterns
CreationalFactory Method, Abstract Factory, Builder, Prototype, Singleton
StructuralAdapter, Bridge, Composite, Decorator, Facade, Flyweight, Proxy
BehavioralChain of Responsibility, Command, Iterator, Mediator, Memento, Observer, State, Strategy, Template Method, Visitor
ArchitecturalMVC, MVP, MVVM, Repository, CQRS, Event Sourcing, Layered (N-tier), Hexagonal (Ports & Adapters), Clean Architecture
ConcurrencyActive Object, Monitor, Thread Pool, Producer-Consumer, Scheduler
FunctionalFunctor, Monad, Pipeline, Lens, Trampolining

Context7

Context7 is the default source for library and framework documentation.

  • Use the context7 tool when you need library or API documentation.
  • Use the context7 tool when you need code generation, setup instructions, or configuration steps.
  • Do not rely on memory for library versions or APIs when verification is needed.

Shell Tool Preferences

Prefer modern CLI search tools for efficiency:

  • Use fd instead of find.
  • Use rg instead of grep.

If either tool is missing, inform the user and ask before running an install command.


These guidelines are working if: fewer unnecessary changes in diffs, fewer rewrites due to overcomplication, and clarifying questions come before implementation rather than after mistakes

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.