Skip to content

Execution Model

Agents is the governed machine-access layer for Craft CMS and Craft Commerce.

A managed account can be used by an external runtime such as an agent, orchestrator, worker, or script.

You set the boundary. External runtimes work inside it. Agents enforces the rules.

Trust boundary

  • Production actions execute through scoped API routes and policy controls.
  • Runtime behavior is deterministic: request validation, stable error codes, auditable records.
  • Managed credentials, scopes, and optional approvals define the production control boundary.
  • External runtimes do the reasoning, orchestration, and tool calling outside Craft.
  • The plugin does not execute agent-provided shell commands as part of production action handling.
  • CLI commands (craft agents/*) are operator/developer tools for diagnostics and workflow support.

Surface stability matrix

SurfaceStatusNotes
Read/sync API (/health, /readiness, /auth/whoami, /products, /variants*, /subscriptions*, /transfers*, /donations*, /orders*, /entries*, /assets*, /categories*, /tags*, /global-sets*, /addresses*, /content-blocks*, /users*, /changes, /sections)Production stableToken/scopes + deterministic error contract.
Integration state API (/sync-state/lag, /sync-state/checkpoint, /templates, /starter-packs, /schema, /lifecycle, /incidents)Production stableCheckpoint/lag, schema/template contracts, lifecycle governance, and redacted runtime incident visibility.
Contract descriptors (/capabilities, /openapi.json, root aliases)Production stableCanonical machine contract discovery.
Webhook delivery + DLQ replay (/webhooks/dlq, /webhooks/dlq/replay)Production stableSigned payloads, retries, dead-letter replay.
Credential controls (scopes, targeted event-routing interests, TTL/reminders, IP allowlists)Production stableManaged in CP, enforced at runtime.
CLI (craft agents/*)Production stable (ops tooling)Operator/dev workflows; not runtime control plane.
Control-plane execution (/control/*, governed-write workflows)ExperimentalEnabled only by PLUGIN_AGENTS_WRITES_EXPERIMENTAL=true.

Why this model

  • Keeps production behavior auditable and policy-constrained.
  • Gives external runtimes one consistent access surface instead of custom endpoint sprawl.
  • Avoids broad shell-execution risk in multi-tenant/production environments.
  • Preserves CLI velocity for operators without making CLI the runtime trust boundary.
  • Makes readiness, sync-state, lifecycle posture, and incident visibility part of the operating model instead of afterthoughts.

See Compatibility & Deprecations for upgrade and contract-change policy.

Governed machine access for Craft CMS and Craft Commerce