A3S Docs
A3S Code

AGENTS.md

Project instructions as first-class context

AGENTS.md

AGENTS.md files give the harness stable project instructions without forcing every prompt to repeat them. Workspace instructions are included in provider request context.

What To Put In AGENTS.md

# Project Instructions

- Use `cargo test -p a3s-code-core` for core changes.
- Never commit secrets from `.a3s/config.acl`.
- Prefer `rg` for search.
- Release checks must include package metadata, CI, and provider verification.

Keep instructions operational: build commands, safety rules, code style, directories, and release practices.

Precedence

Session options, explicit user instructions, skills, and AGENTS.md are composed by the harness. Keep side-effect policy in host application controls and verified integration tests.

Good Practice

  • Keep project instructions short and testable.
  • Put secrets in environment variables, not in AGENTS.md.
  • Use nested AGENTS.md files only when subdirectories truly differ.
  • Update AGENTS.md when release or test commands change.

On this page