Agents

Agents is a read-only, agent-ready interface for Craft CMS and Craft Commerce.

It gives operations teams, developers, and AI-assisted workflows a stable way to inspect shop and content state without exposing write actions. The plugin is designed for safe automation: strong discoverability, predictable payloads, and clear boundaries.

What Agents Does

Agents adds two complementary access surfaces:

• HTTP API endpoints under /agents/v1
• Craft CLI commands under craft agents/*

The API covers both Commerce and content:

• Health and readiness checks
• Product snapshots
• Order listing and single-order lookup
• Entry listing and single-entry lookup
• Section listing
• Capability discovery and OpenAPI output

The CLI provides equivalent read-only access for scripts, cron jobs, and local diagnostics:

• agents/product-list
• agents/order-list
• agents/order-show
• agents/entry-list
• agents/entry-show
• agents/section-list

Built for Agent Workflows

Agents is intentionally text- and machine-friendly:

• Simple endpoint model
• Stable response shapes
• Capability discovery endpoint
• OpenAPI descriptor endpoint
• Human-readable CLI output with optional JSON mode

This makes it practical for automation pipelines, support runbooks, monitoring, and LLM-driven tooling that needs fast, low-friction data access.

Security and Operational Controls

Agents includes built-in protections for production environments:

• Token-based API authentication
• Configurable request rate limiting
• Explicitly read-only scope by design

Configuration is environment-based with dedicated plugin variables (PLUGIN_AGENTS_*), so behavior is easy to manage per environment.

Why "Read-Only" Matters

Many automation integrations fail by mixing diagnostics with mutation too early. Agents starts from a safer model:

• No order edits
• No product writes
• No destructive content actions

You get high observability with low operational risk, which is ideal for teams introducing AI and automation into existing Craft setups.

Typical Use Cases

• Nightly and on-demand operational health checks
• Product/order/content visibility for external integrations
• Agent-assisted support tooling
• Read-only dashboards and internal diagnostics
• Change monitoring and release verification workflows

Compatibility

• Craft CMS 5+
• PHP 8.2+

Agents is a pragmatic foundation for teams who want agent-ready visibility now, while keeping production behavior controlled and predictable.