# Overview

The Inistate MCP server lets AI assistants — Claude, ChatGPT, and others — read and write your Inistate workspace data through natural conversation. Ask the AI to query entries, submit activities, design new modules, or generate custom UI code, all without leaving your chat.

## Prerequisites

* An active Inistate account
* At least one workspace set up in Inistate

If you don't have an account yet, contact your Inistate administrator or sign up at [app.inistate.com](https://app.inistate.com).

## The Three Modes

The server exposes different capabilities depending on the active mode. The default is **configure**, which includes both entry operations and module design tools.

| Mode                      | What it unlocks                                                        | Switch command          |
| ------------------------- | ---------------------------------------------------------------------- | ----------------------- |
| **configure** *(default)* | Entry CRUD + module design and schema tools                            | `switch_mode configure` |
| **runtime**               | Entry queries, activities, history, and file uploads only              | `switch_mode runtime`   |
| **frontend**              | Everything in configure + REST API reference for custom UI development | `switch_mode frontend`  |

{% hint style="info" %}
You can switch modes at any time by telling your AI assistant: *"Switch to runtime mode"* or *"Switch to configure mode."* The tool surface updates immediately without reconnecting.
{% endhint %}

## What do you want to do?

<table data-view="cards"><thead><tr><th>Title</th><th>Description</th><th data-card-target data-type="content-ref">Target</th></tr></thead><tbody><tr><td>Getting Started</td><td>Connect your AI assistant to the hosted Inistate MCP endpoint.</td><td><a href="/pages/wrIehFhYr45fpR1hINtm">/pages/wrIehFhYr45fpR1hINtm</a></td></tr><tr><td>Working with Entries</td><td>Query, create, edit, delete entries and view audit history.</td><td><a href="/pages/LNRmaE9DLNotZOqJkQah">/pages/LNRmaE9DLNotZOqJkQah</a></td></tr><tr><td>File Uploads &#x26; Downloads</td><td>Attach files to entries and retrieve existing files.</td><td><a href="/pages/aNJXwQVYVU2EdTnD2Xfb">/pages/aNJXwQVYVU2EdTnD2Xfb</a></td></tr><tr><td>Designing Modules</td><td>Use AI to design new workflow modules from scratch.</td><td><a href="/pages/KDVrv6jQ19g1xLILTr7N">/pages/KDVrv6jQ19g1xLILTr7N</a></td></tr><tr><td>Modifying Modules</td><td>Add fields, states, or activities to existing modules.</td><td><a href="/pages/cedKtjxLnCXHOs9qcBXv">/pages/cedKtjxLnCXHOs9qcBXv</a></td></tr><tr><td>Building Custom UIs</td><td>Generate Vue/React code that calls the Inistate REST API directly.</td><td><a href="/pages/NPHNHcx2xywoN3BDa2h3">/pages/NPHNHcx2xywoN3BDa2h3</a></td></tr></tbody></table>


---

# 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/mcp.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.