# agent.yaml

Canonical: https://auggy.dev/docs/agent-yaml
Status: Published
Package: auggy 0.5.0

Configure identity, engine, and enabled augment order for an agent project.

## Role

agent.yaml is the runtime source of truth for an agent project. It declares identity, model-provider configuration, settings, and enabled augment order.

**Scaffolded shape**

```yaml
name: my-agent
displayName: My Agent
purpose: Help visitors with product and support workflows.
creator:
  displayName: Operator
identity: ./identity.md

engine:
  provider: anthropic
  model: claude-sonnet-4-6
  maxContextTokens: 200000
  maxTokens: 4096
  # reasoningEffort: medium
  # costOverride:
  #   inputUsdPerMtok: 3
  #   outputUsdPerMtok: 15

settings:
  compactionStrategy: truncate
  maxInferenceLoops: 10

augments:
  - fileMemory
  - filesystem
  - webTransport
  - webFetch
  - turnControl
  - knowledge
```

## Rules

- Keep secrets in .env, not agent.yaml.
- Use engine.provider and engine.model for model selection; use maxContextTokens, maxTokens, and provider-specific fields for runtime behavior.
- Treat augment order as part of runtime behavior.
- Use augment-specific config in augments/<id>/augment.yaml.

## Related

- [defineAugment](https://auggy.dev/docs/define-augment/markdown)