AGENTS.md

AGENTS.md is a Markdown file at the root of your project that the agent reads at the start of every conversation. Put in it what you would otherwise repeat in every prompt: how the code is laid out, how to build and test it, and what not to touch.

It follows the open AGENTS.md convention, so the same file works with other coding agents. The CLI, the VS Code extension and the Desktop app all read it.

Where it goes

Create AGENTS.md in the root folder of your project. That is all. No setting to change, no restart.

my-project/
├── AGENTS.md          ← read at the start of each conversation
├── src/
└── package.json

The root file is the one sent automatically. The agent knows that subfolders may hold their own AGENTS.md and reads them with its file tools when it works there. Keep the root file short and put area-specific detail next to the code it describes.

There is no global instructions file. For rules you want in every project, write a skill in ~/.abacusai/skills/ instead.

What to put in it

# Acme Web App

## Stack
- TypeScript + React (Vite), Tailwind for styling.
- Backend: Python (FastAPI) under `server/`.

## Conventions
- Functional components and hooks only. Named exports.
- 2-space indentation, single quotes.

## Build and test
- Install: `npm install`
- Dev server: `npm run dev`
- Before finishing any task: `npm run lint && npm run typecheck`
- Tests: `npm test`

## Don'ts
- Never edit files under `src/generated/`. They are generated.
- Don't commit `package-lock.json` changes unless a dependency changed.

What makes the file work well:

• Lead with the rules the agent must not miss.
• Spell out exact commands. The agent runs them to check its own work.
• Prefer short bullets to prose.
• Update it when conventions change, and review it in pull requests like code.

How it is used

The file is read when you send the first message of a conversation and stays with that conversation. Edits show up in your next new conversation.

Very long files are cut at 40,000 characters, with a note asking the agent to read the rest from disk when it needs it. Well under that is plenty.

Turn it off

Where	How
One CLI session	abacusai --no-agents-md
CLI	/settings, then switch off "Load AGENTS.md"
VS Code	Abacus Settings, Agent section, "Auto-load AGENTS.md"
config.json	"autoLoadAgentsMd": false
Environment	ABACUS_AUTO_LOAD_AGENTS_MD=false

See Settings for how these combine.

AGENTS.md, skills or settings?

You want to	Put it in
Describe the project, its conventions and its commands	AGENTS.md
Package a repeatable procedure, loaded only when it is relevant	A skill
Enforce something rather than ask for it, such as never reading .env	A permission rule in Settings
Give the agent access to an external service	An MCP server

For further help, reach out at support@abacus.ai.