AI Agent Operating Guides
Use these guides when an AI Agent workflow is moving from a demo into a controlled pilot or production operation. The pages focus on access, data, run records, review, troubleshooting, and output examples.
Guide map
| Guide | Use it when | Main output |
|---|---|---|
| Access and Scope Planning | A client, workflow, or integration needs an endpoint and API key | Endpoint choice, scope list, key owner, and approval boundary |
| Data Readiness | A workflow needs reliable asset, signal, document, scene, or work-order context | Data gap list, source mapping, and quality checks |
| Workflow Run Record | A workflow execution must be reviewed or audited later | Input boundary, tool calls, source references, review notes, and final result |
| Validation and Handover | A pilot is being accepted by operations, maintenance, or engineering teams | Acceptance checks, owner handover, support boundary, and improvement loop |
| Troubleshooting | A client, scope, data, tool, or output issue blocks a workflow | Triage path and evidence for the responsible team |
| Examples | A team needs request and response patterns before implementation | Example prompts, tool context, output formats, and review notes |
Operating sequence
- Define the workflow boundary, endpoint, scopes, and key owner.
- Check whether the required assets, signals, documents, scenes, and work records are ready.
- Run the workflow in read-only mode and record tool outputs with source references.
- Add compute tools only when the assumptions and review owner are visible.
- Add draft write actions behind approval, audit, and rollback procedures.
- Review completed runs and feed accepted corrections back into the data and knowledge layers.
Review gates
| Gate | Required check |
|---|---|
| Access gate | The client sees only the tools allowed by its endpoint and scopes. |
| Data gate | Source records resolve to stable asset, location, scene, or work-order identifiers. |
| Output gate | The answer includes source references, assumptions, and unresolved gaps. |
| Action gate | Any write action remains draft until an approved person accepts it. |
| Handover gate | The operating team knows who owns keys, workflows, exceptions, and support. |
Choosing the next page
- Start with Access and Scope Planning when the client or permission model is still being designed.
- Start with Data Readiness when the workflow depends on external systems, DFS pipelines, or customer documents.
- Start with Workflow Run Record when the team already has a working pilot and needs repeatable review evidence.