@statelyai/mcp 0.8.2 → 0.8.4

package/README.md

@@ -76,8 +76,8 @@ Complete Stately sign-in when the client connects.
 <!-- shared machine input schemas from src/server.ts -->
 
 Most tools accept a machine config object or a source document. Conversion
-supports XState, SCXML, XGraph, and D2. Validation also supports JSON, YAML, and
-Mermaid.
+accepts XState, SCXML, XGraph, Mermaid, and D2 sources; target formats exclude
+Mermaid. Validation also supports JSON and YAML.
 
 ## `validate_machine`
 
@@ -111,8 +111,9 @@ createMachine({
 
 <!-- convert_machine registration from src/server.ts and convert response contract -->
 
-Converts a machine between XState, SCXML, XGraph, and D2. The response contains
-the target `format`, converted `content`, and any `warnings`.
+Converts XState, SCXML, XGraph, Mermaid, or D2 input to XState, SCXML, XGraph,
+or D2. The response contains the target `format`, converted `content`, and any
+`warnings`.
 
 <details>
 <summary>Summary: convert XState to SCXML</summary>
@@ -317,11 +318,22 @@ createMachine({
 MCP Apps hosts render an interactive, read-only graph with hierarchy drill-in,
 breadcrumbs, selection utilities, pan/zoom, and viewport keyboard shortcuts.
 Pass XState source text (the default for strings), a JSON machine config, SCXML,
-XGraph, or D2; the server converts it to canonical XGraph for the app.
+XGraph, Mermaid, or D2; the server converts it once to canonical XGraph before
+rendering the app and PNG fallbacks.
 Other image-capable clients receive one PNG fallback per parent node. Structured
-content includes the raw XGraph plus hierarchy metadata without duplicating
-image data. Use `parentNodeIds` to limit PNG fallback levels; omit it to render
-every parent with direct child states.
+content uses a required `schemaVersion: "2.0"` envelope with a canonical XGraph
+JSON string in `interactive.graphJson`. Every V2 field has a concrete JSON
+schema so hosts can persist the result without traversing open XGraph data.
+`interactive` and `pngFallback` independently report `ready` or `unavailable`,
+so PNG rendering may succeed when the persisted interactive graph is unavailable.
+The graph is capped at 500,000 UTF-8 bytes by default and PNG metadata at 100
+entries; image bytes remain native MCP content blocks. Use `parentNodeIds` to
+limit PNG fallback levels; omit it to render every parent with direct children.
+
+The App reads only this declared structured output. The stable resource URI is
+retained: newer bundles decode V2, V1, and the earlier unversioned `graph` /
+`graphError` shape. Saved results created before graph fields were declared
+cannot be reconstructed and deliberately ask the user to run the tool again.
 
 Each returned image uses the MCP `ImageContent` shape: