Checked against official documentation on May 24, 2026, this post focuses on the setup and failure points behind Codex AGENTS.md Setup: Make Project Instructions Load Correctly. The practical baseline is: Put shared rules in the repository root, narrower rules near specialized folders, and temporary overrides in AGENTS.override.md only while needed.

Quick Answer

Put shared rules in the repository root, narrower rules near specialized folders, and temporary overrides in AGENTS.override.md only while needed.

The practical rule is simple: keep the agentโ€™s authority narrower than the task. Installation, settings, MCP tools, and repository instructions should be treated as part of the engineering system, not as one-time setup trivia.

Codex AGENTS.md Setup: Make Project Instructions Load Correctly workflow diagram

When This Setup Matters

AGENTS.md is the project instruction file Codex reads for repository rules, test commands, and forbidden actions. This matters when a developer wants repeatable AI-agent help instead of a long ad hoc prompt. A good setup makes three things visible: what the agent may read, what it may change, and how the human will verify the result.

If the tool is being introduced to a team, write the decision down before broad use. Name the account or authentication path, the directory where the agent should start, the files it must not touch, and the command that proves a change is acceptable.

Baseline Commands

mkdir -p ~/.codex
printf '# Working agreements\n- Run tests before commit.\n' > ~/.codex/AGENTS.md
codex --ask-for-approval never "List the instruction sources you loaded."

Run commands from the same shell and project root where the agent will work. If a command succeeds in one terminal but fails in another, fix the shell, PATH, account, or working-directory issue before asking the agent to edit code.

Configuration Pattern

project_doc_fallback_filenames = ["TEAM_GUIDE.md", ".agents.md"]
project_doc_max_bytes = 65536

Treat this block as a starting pattern, not a universal default. A personal laptop, a locked-down company workstation, and a CI job should not have the same permission model. Prefer read-only or planning modes until the repositoryโ€™s tests and rollback path are clear.

For recurring use, keep a short setup note beside the repository. Include the CLI version, the selected permission mode, the instruction file that loaded, and the exact command used for the final verification. That note becomes the baseline when a teammate reports different behavior.

Verification Checklist

  • Ask codex to list loaded instruction files.
  • Verify root rules appear before nested overrides.
  • Keep secrets out of instruction files.

After the setup works, ask the agent for a read-only summary first. Then ask for a narrow plan. Only after those two responses match the repository reality should you allow edits or tool calls that can change files.

Common Mistakes

  • Duplicating contradictory rules.
  • Putting credentials in agents.md.
  • Forgetting to remove agents.override.md.

The costly mistake is usually not a bad model answer; it is an unclear operating boundary. If authentication, MCP scope, settings precedence, or instruction files are ambiguous, the session can appear productive while quietly moving risk into code review.

FAQ

Should this be configured globally or per project?

Put personal preferences globally, but put repository rules in project files so every teammate and future session sees the same constraints. Secrets, local paths, and experiments should stay out of committed project files.

When should I allow the agent to edit files?

Allow edits only after the agent can restate the task, name the files it expects to touch, and identify the verification command. For unfamiliar repositories, start in planning or read-only mode.

What should I record after the setup works?

Record the install method, version check, account or API-key policy, permission mode, instruction file location, MCP scope, and the first verification command. This gives the next session a reproducible baseline.

Source Notes

Leave a comment