Inistate MCP Server

Official

by Inistate

Overview Schema Source Related Servers Discussions Admin

TypeScript

Remote

Update Module

update_module

DestructiveIdempotent

Update an existing Inistate module by replacing specified information, states, activities, or flows; include item IDs to keep or rename entries. Omit sections to leave them unchanged.

Instructions

Update an existing module. A section you pass (information/states/activities/flows) replaces that section's entire list — include every existing item you want to keep (matched by id, which enables renaming; omit id to add new items). Omitted sections are left unchanged. Always call get_module_canvas first to obtain the stable module id and item ids. Full-canvas payloads (information included) are validated internally like create_module; for partial payloads, validate the merged canvas with validate_design first.

Input Schema

TableJSON Schema

Name	Required	Description
`id`	Yes	Module id from get_module_canvas. Identifies which module to update.
`card`	No	The listing card designed with the schema — how each entry shows in the module's list (mobile and web). Fields and activities by NAME. See CardDefinition in inistate://schema/configure. A card that does not pass never fails the call: the module gets the platform's default card and the response's cardStatus says why.
`icon`	No	Emoji identifier
`name`	No	New module name (for renaming)
`flows`	No	State transition rules: { from, to, activity } by name. Omit for record list modules.
`states`	No	Workflow states. Omit for record list modules.
`activities`	No	Custom activities. Omit for record list modules.
`description`	No
`information`	No	Field definitions. Items matched by id on update enable renaming.
`workspaceId`	No	Workspace ID. Omit if set via env or set_workspace; required in stateless/remote mode.

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv1.3.1Oct 17, 2026

addedInput schema / properties / card

Added value: +{
+  "additionalProperties": false,
+  "description": "The listing card designed with the schema — how each entry shows in the module's list (mobile and web). Fields and activities by NAME. See CardDefinition in inistate://schema/configure. A card that does not pass never fails the call: the module gets the platform's default card and the response's cardStatus says why.",
+  "properties": {
+    "action": {
+      "description": "'view' (the default when activities exist), 'edit', or an activity name",
+      "type": "string"
+    },
+    "icon": {
+      "additionalProperties": false,
+      "description": "Detail only",
+      "properties": {
+        "field": {
+          "description": "An Image, Images, File, Files or Selection field, by name",
+          "type": "string"
+        },
+        "size": {
+          "description": "XS | S | M | L (S for a Selection, M for an image)",
+          "type": "string"
+        }
+      },
+      "required": [
+        "field"
+      ],
+      "type": "object"
+    },
+    "rows": {
+      "description": "1–5 rows of 1–3 items: the state row first (or the defaultCard widget alone), the title field L/b, secondary fields S/M, activities in their own row",
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "items": {
+            "description": "1–3 items",
+            "items": {
+              "additionalProperties": false,
+              "properties": {
+                "name": {
+                  "description": "Field or activity name; 'defaultCard' for the widget; unused for state",
+                  "type": "string"
+                },
+                "orientation": {
+                  "description": "Image/File fields only: portrait | landscape",
+                  "type": "string"
+                },
+                "ratio": {
+                  "description": "Image/File fields only: 1:1 | 3:2 | 4:3 | 16:9",
+                  "type": "string"
+                },
+                "settings": {
+                  "additionalProperties": {},
+                  "description": "defaultCard widget switches (booleans): title, state, assignees, comment, createdBy, createdDate, due, documentId",
+                  "type": "object"
+                },
+                "size": {
+                  "description": "S | M | L — Text, number and date fields only",
+                  "type": "string"
+                },
+                "style": {
+                  "description": "l | n | b — Text, number and date fields only",
+                  "type": "string"
+                },
+                "type": {
+                  "description": "field | state | activity | widget",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "type"
+              ],
+              "type": "object"
+            },
+            "type": "array"
+          }
+        },
+        "required": [
+          "items"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "size": {
+      "description": "Grid only: S | M | L",
+      "type": "string"
+    },
+    "type": {
+      "description": "'grid' when the module has an Image/Images field (the image alone in row 1); otherwise 'detail' with an icon",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type"
+  ],
+  "type": "object"
+}

addedInput schema / properties / information / items / properties / display

Added value: +{
+  "description": "User/Users/Module/Modules only: name of the connected module's field shown for a picked record. Omit to default (Full Name/Name for users, else the first Text field).",
+  "type": "string"
+}

First observedv1.1.1Jul 28, 2026

TDQS

A4.7/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and idempotentHint=true, and the description goes beyond them by explaining exactly what is destroyed: a passed section replaces the entire list, so any existing item omitted is lost. It also discloses the id-matching rule (rename vs. add) and the pre-flight requirements, which the annotations alone cannot convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action, then the destructive replacement rule, then prerequisites and validation. Dense and all four sentences carry information, though the parenthetical detail about id/rename/omit makes it slightly heavy for a first read.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 10-parameter, deeply nested mutation tool this covers the critical workflow: how sections behave, what to call first, and how to validate. With no output schema, the response shape is only partially covered (it references cardStatus but not the rest of the return payload), leaving a small gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 90%, so the baseline is 3; the description still adds real meaning by explaining the id-matching/renaming and omit-id-to-add semantics across sections, plus the section-replacement rule that no single property description states. It stops short of describing id/workspaceId sourcing beyond pointing at get_module_canvas.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb+resource ('Update an existing module') and immediately scopes which parts can change (information/states/activities/flows). It also distinguishes itself from create_module by noting internal validation parity, so an agent can place it relative to siblings without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit prerequisites and alternatives: 'Always call get_module_canvas first to obtain the stable module id and item ids,' and for partial payloads 'validate the merged canvas with validate_design first.' It also states what happens to omitted sections, so the when-to-use and how-to-sequence guidance is complete.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Update Module

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools