Skip to content

Use AGENTS.md for project instructions

AGENTS.md is an emerging open standard for providing project-level instructions to AI agents, backed by OpenAI, Google, Cursor, Sourcegraph, and others. Everruns ships it as the default file for its built-in agent instructions capability, which re-reads configured files on every turn.

Terminal window
curl -X PATCH http://localhost:9300/api/v1/agents/$AGENT_ID \
-H "Content-Type: application/json" \
-d '{
"capabilities": [
{ "ref": "agent_instructions" },
{ "ref": "session_file_system" }
]
}'

session_file_system isn’t required, but pairing it with agent_instructions lets the agent edit AGENTS.md itself.

To also read another instruction file, configure files on the capability:

Terminal window
curl -X PATCH http://localhost:9300/api/v1/agents/$AGENT_ID \
-H "Content-Type: application/json" \
-d '{
"capabilities": [
{
"ref": "agent_instructions",
"config": {
"files": ["AGENTS.md", "CLAUDE.md"]
}
},
{ "ref": "session_file_system" }
]
}'

Drop a plain Markdown file at /workspace/AGENTS.md in the session:

## Project: Acme API
REST API built with Rust + Axum. PostgreSQL for storage.
## Style
- snake_case for variables and functions
- PascalCase for types
- Keep functions under 50 lines
## Build & Test
cargo build
cargo test --all-features
cargo clippy -- -D warnings
## Architecture
- `src/api/` — HTTP handlers
- `src/domain/` — Business logic
- `src/db/` — Database queries
## Commits
Use conventional commits: `feat(scope): description`

There are no required sections. Write whatever a new contributor would need to know.

When the capability is enabled, the system prompt is composed top-to-bottom:

  1. Instruction file content — project-level instructions.
  2. Capability system prompt additions — tool guidance.
  3. Agent’s base system prompt — the agent’s role.

Project context comes first, so capability and agent prompts can reference it.

  • Content is capped at 32 KiB (32,768 bytes) per file. Excess is silently truncated.
  • Configured files are re-read on every turn. Edits during a session apply on the next turn — no restart needed.
  • If a configured file doesn’t exist, the agent operates normally without it.

Everruns reads AGENTS.md by default. Add other file names to files when an agent should also read CLAUDE.md, .cursorrules, or .github/copilot-instructions.md.