FactVerse AI Agent Documentation Guide
FactVerse AI Agent documentation is organized around practical implementation work: understand the platform boundary, connect a governed MCP client, design workflows, review examples, troubleshoot failures, and validate handover.
Use this page to choose the right document for the task in front of you.
Documentation selection flow
Start here
| Task | Use |
|---|---|
| Understand what FactVerse AI Agent is | Overview |
| Connect an MCP client for the first time | Getting Started |
| Plan endpoints, API keys, scopes, and approval boundaries | Access and Scope Planning |
| Check whether assets, signals, documents, and scenes are ready | Data Readiness |
| Learn tenant, asset, scope, approval, and audit concepts | Core Concepts |
| Review request and output patterns | Examples |
| Build a task-oriented workflow | Workflow Guides |
| Record evidence, review decisions, actions, and feedback | Workflow Run Record |
| Diagnose connection, scope, data, or simulation failures | Troubleshooting |
| Prepare acceptance and operating handover | Validation and Handover |
Workflow areas
FactVerse AI Agent documentation currently focuses on three workflow areas.
| Area | Concept page | Workflow guide |
|---|---|---|
| Facility operations | Facility Operations | Facility Operations Workflow Guide |
| Predictive maintenance | Predictive Maintenance | Predictive Maintenance Workflow Guide |
| Physical AI | Physical AI | Physical AI Workflow Guide |
Use concept pages to understand business context. Use workflow guides when preparing data, selecting scopes, designing tool flow, defining review points, and recording outcomes.
Reference pages
| Reference | Use |
|---|---|
| MCP Overview | Understand governed tool access and endpoint structure. |
| MCP Integration Guide | Configure MCP clients and connection settings. |
| MCP Capability Guide | Understand endpoint families, capability categories, and workflow selection. |
| MCP Scope Matrix | Plan scopes, reviewers, and access packages. |
| MCP Errors and Audit | Diagnose failures and keep review records. |
| Tool Reference | Check tool names, scopes, descriptions, and parameters. |
| Scope Reference | Check endpoint, module, and scope requirements. |
The Tool Reference supports planning and review. Runtime tool discovery remains the source for what a specific customer environment and API key can call.
Review pattern
A complete Agent workflow should keep the following items visible:
- tenant, site, asset, equipment, or scene boundary;
- endpoint and scopes used by the client;
- source systems, timestamps, and data quality notes;
- tool results, evidence, and assumptions;
- review owner and approval state;
- final work order, inspection, scenario, or validation record.
Documentation ownership rule
| Content type | Belongs in |
|---|---|
| What a product area can do | Module or use-case page. |
| How to run a workflow | Workflow guide or recipe. |
| How to configure access | MCP and access planning pages. |
| How to prepare source data | DFS pages. |
| How to inspect exact tools and scopes | Tool and scope reference pages. |
| How to record evidence and handover | Run record, validation, and handover pages. |