Skip to main content

Agent reference

This section is the spec — for Agents. Field-by-field schemas, error codes, audit-trail formats, OIDC details, rate limits, build-path resolution algorithms. Everything an Agent needs to operate ERun without guessing.

The rest of the docs is for Operators. Operators get the concepts and the workflow; they don't need to read field tables, because the Agent handles those details. If you find yourself reaching for the field reference as an Operator, that's usually a signal the Agent should be doing the work — see Agent patterns.

Inside​

  • Concepts — the platform's mental model. Tenants, environments, types, what's inside the runtime pod, networking, observability, security, conventions, cloud contexts. The Operator sees the high-level summary in the intro; the Concepts pages explain how it works.
  • MCP protocol + tools — the typed-tool surface for an environment. Three categories (inspection / action / escape) and the full tool schemas.
  • Agent patterns — ten patterns Agents converge on: orient first, doctor before raw, skill before hand-writing, build-verify-deploy, etc.
  • erun API
  • Platform spec
    • Conventions spec — resolution algorithms (project root, Dockerfile, VERSION, command overrides, fingerprint cache).
    • Idle-stop policy — eligibility predicate, working-hours semantics, resume mechanics.
  • Configuration spec

What the Agent is responsible for​

Per the Operator/Agent split, an Agent is responsible for the following classes of detail the Operator shouldn't have to think about:

What stays in the Operator's hands​

The Operator should not need to memorise the field tables. The Agent should be able to look any of them up without bothering the Operator.