FlowRelay
Agent Access
Choose an agent mission
Use this page when an operator has named the task but the authorized agent still needs the correct FlowRelay path. It provides the common read, preview, act, and escalate sequence; follow the linked setup, recovery, diagnostics, or request guide for the full procedure. A mission never widens the active grant.
On this page
Agent workflow
Agents should orient through docs before using authenticated tools.
-
Identify the smallest mission
Start with the operator's mission and identify the smallest FlowRelay job that can answer it.
-
Orient through docs and manifest
Read /llms.txt, the task-specific Markdown page, /agent/v1/manifest, and the current grant before authenticated work.
-
Read current state
Read setup state, plan usage, and the relevant endpoint or event facts before proposing an action.
-
Check availability and authority
Compare the mission against the manifest capability, required scopes, object state, usage state, and safety boundary.
-
Prepare the lowest-risk action
Prepare only the lowest-risk action that fits the mission, such as a read, preview, sender handoff, support request, expansion request, or feature request.
-
Escalate outside the grant
Escalate when the mission asks for billing approval, grant changes, Shopify Flow edits, raw private data, unsupported platforms, or judgment outside the merchant-authorized grant.
Mission routing #
Agents should translate the operator's request into a FlowRelay mission before choosing routes or tools. The same playbook applies whether the agent uses direct API calls, the CLI, or MCP Agent Operations access.
- Set up a new event path with an agentFull procedure for a new endpoint and first proof.
- Move an existing event path with an agentFull procedure for an existing sender or receiver path.
- Choose a support or product requestRequest classification, fields, and commitment boundaries.
| Operator mission | Gather first | Allowed next step | Escalate when |
|---|---|---|---|
| Set up the first endpoint | Manifest, grant, setup state, trigger mapping reference, and plan usage. | Create or inspect an endpoint when endpoint write authority is present, then guide the merchant through Shopify Flow trigger setup. | The agent is asked to edit Shopify Flow directly, approve billing, expose secrets, or choose an unclear trigger variant without operator confirmation. |
| Investigate a failed event | Event history, event detail, receipt facts, support code, endpoint snapshot, and retention state. | Explain what FlowRelay can prove, identify the likely boundary, and suggest resend, setup fix, replay preview, or diagnostics. | The receipt cannot prove downstream Shopify Flow behavior or the operator asks for raw event bodies or private logs. |
| Recover an event | Event detail, replay availability, endpoint state, Shopify Flow readiness, plan usage, grant scopes, and replay guidance. | Preview replay when retained event material and authority are available; execute only with required confirmation. | Retention expired, replay may duplicate customer-visible actions, the grant lacks replay authority, or the merchant needs Shopify Flow workflow changes. |
| Share diagnostics | Receipt or endpoint target, support code, diagnostics state, grant scopes, and diagnostics guidance. | Preview and create a redacted diagnostics share when authorized. | The request asks to include raw payloads, full headers, secrets, tokens, customer data, or copied private incidents. |
| Request support | Support consent, diagnostics share, endpoint ID, event ID, support code, urgency, and redacted summary. | Preview and submit a structured support request when the grant and operator consent allow it. | Consent is unclear, contact ownership is unclear, or the request would expose private material. |
| Request expansion | Merchant task, requested platform or capability, FlowRelay fit, business impact, and current edition boundary. | Submit a non-binding expansion request when it is tied to FlowRelay event intake, reliability, handoff recovery, diagnostics, or approved agent operation. | The request is a generic product wishlist item or asks the agent to treat an unsupported edition as live. |
| Request a FlowRelay feature | Feature area, FlowRelay fit, triggering context, concrete merchant workflow, current gap, desired outcome, linked support/diagnostics/event/endpoint context, and idempotency key. | Submit a non-binding feature request when the missing capability is inside FlowRelay's current reliability, receipts, recovery, diagnostics, Agent Operations, billing/usage, security, or docs surface. | The request is actually support, future-platform expansion, a generic wishlist, or a request to build unrelated software. |
Context order #
Use a fixed context order so the agent does not jump from a mission directly to side effects.
| Step | Context | Purpose |
|---|---|---|
| 1 | Docs and manifest | Confirm live edition, public guidance, route names, capability metadata, and safety boundaries. |
| 2 | Grant and scopes | Confirm the merchant-authorized authority for this agent and task. |
| 3 | Plan usage | Avoid broad reads, repeated previews, or recovery work that would hit usage safeguards. |
| 4 | Setup, endpoint, event, or diagnostics target | Ground the answer in the specific store, endpoint, receipt, event, or share. |
| 5 | OpenAPI request shape | Call the exact contract only after the product meaning and authority are clear. |
Acting on the mission #
Treat the mission as a bounded job. The grant, not the mission name, defines what the agent may do. After context gathering, the agent should choose the lowest-risk action that satisfies the operator's mission. Reads come before previews; previews come before execution; sender or human handoffs come before actions outside FlowRelay's boundary.
Output expectations #
Agent responses should state what FlowRelay knows, what FlowRelay cannot prove, which docs or receipt facts support the answer, what action is available, what is blocked, and which human approval or external system is needed when the mission goes beyond FlowRelay.