Skip to content

AGENTS.md

Multi supports AGENTS.md, an open format for guiding coding agents that’s used by many and a growing ecosystem of AI coding tools.

Think of AGENTS.md as a README for agents: a dedicated, predictable place to provide the context and instructions Multi needs to work effectively on your project.

README.md files are for humans: quick starts, project descriptions, and contribution guidelines. AGENTS.md complements this with the extra, agent-focused context that might clutter a README:

  • Build, test, and lint commands
  • Code style and conventions
  • Testing instructions
  • Security considerations
  • PR and commit message guidelines

Keeping agent instructions in their own file gives Multi (and other compatible agents) a clear, predictable place to look, while keeping your README.md focused on human contributors.

Create an AGENTS.md file at the root of your workspace. Multi automatically loads it into the agent’s context at the start of every task. If the file isn’t present, Multi simply runs without it - no configuration required.

Add sections that help Multi work effectively with your project. Popular choices include:

  • Project overview
  • Build and test commands
  • Code style guidelines
  • Testing instructions
  • Security considerations
AGENTS.md
## Dev environment tips
- Install deps: `pnpm install`
- Start dev server: `pnpm dev`
- Run tests: `pnpm test`
## Code style
- TypeScript strict mode
- Single quotes, no semicolons
- Prefer functional patterns
## Testing instructions
- Run `pnpm test` before committing
- Add or update tests for code you change
- Fix any test or type errors before finishing
## PR instructions
- Title format: [area] Title
- Always run `pnpm lint` and `pnpm test`

Multi reads a single AGENTS.md from the workspace root and uses it as agent context. There is no global ~/.multi/AGENTS.md override and Multi does not currently traverse nested AGENTS.md files in monorepo subdirectories - put the instructions you want Multi to follow in the workspace-root file.

The file is treated as authoritative project guidance: Multi is instructed to follow it strictly, but it will not change Multi’s personality or available tools (those come from Personas and the agent itself).

Are there required fields? No. AGENTS.md is just standard Markdown - use any headings that make sense for your project.

What if instructions conflict? Multi loads the workspace-root AGENTS.md and is instructed to follow it strictly; explicit user prompts in chat always take precedence over the file.

Can I update it later? Absolutely. Treat AGENTS.md as living documentation and evolve it as the project changes.