# Resources

MCP resources are read-only data sources the AI loads as context when needed. You do not interact with them directly — the AI fetches them automatically based on the current mode and task.

## Always Available

### `inistate://modules`

A JSON list of all FACTSOps modules in the active workspace. The AI loads this for quick capability indexing at session start.

***

### `inistate://modules/{name}/canvas`

The basic schema for a named module: information fields and states only.

Replace `{name}` with the module name (e.g., `inistate://modules/Invoice/canvas`).

***

### `inistate://modules/{name}/canvas/extended`

The full schema for a named module: fields, states, activities, and flows.

Replace `{name}` with the module name.

***

### `inistate://guardrails`

Server-enforced submission rules for `submit_activity`. The AI reads this once per session before submitting any activity. Covers:

* Human-actor rejection rules
* Hybrid-actor confirmation requirements
* State-change confirmation flow
* Confidence-inflation prevention

***

### `inistate://schema/runtime`

Type definitions and operator reference for runtime operations. The AI loads this when working with entries, activities, and file uploads. Contains:

* `list_entries`, `get_entry`, `get_form`, `submit_activity`, `get_entry_history` type shapes
* File/Image/Module/User field value shapes
* Filter operator reference
* Presigned upload and download flow

{% hint style="info" %}
The AI loads **either** `schema/runtime` or `schema/configure` depending on the task — not both. Loading both doubles context cost unnecessarily.
{% endhint %}

***

## Configure Mode

Available in **configure** and **frontend** modes.

### `inistate://schema/configure`

The full module design schema. The AI loads this when creating or modifying modules. Contains:

* `ModuleSchema` write format
* `FieldDefinition`, `StateDefinition`, `ActivityDefinition`, `FlowDefinition`
* State color palette with assignment rules and keyword hints
* Module type reference (`workflow` vs `record list`)
* Configure-mode tool reference

Pair with `inistate://design-guide` for complete design context.

***

### `inistate://design-guide`

The FACTS Module Design Guide in Markdown. The AI loads this alongside `schema/configure` during module design. Contains:

* Requirements gathering questions
* State color system (8 colors with decision rules)
* SVG workflow diagram specification
* FACTSOps design rules and the Three Laws

***

## Frontend Mode

Available in **frontend** mode only.

### `inistate://frontend-guide`

The REST API reference for building custom Vue/React interfaces that call `api.inistate.com` directly. The AI loads this in frontend mode when generating UI code. Contains:

* Authentication (Bearer token + workspace ID header)
* Workspace and module discovery endpoints
* Entry list, read, form, submit, and history endpoints
* Filter operator syntax
* Field value shapes (File, Image, User, Module)
* Two-step presigned upload flow
* Error response shapes
* Framework-agnostic client pattern, with Vue and React reference implementations


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://inistate.gitbook.io/home/mcp-integration/reference/resources.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
