Skip to content

@maxhealth.tech/prefab / mcp / DisplayA2uiOptions

Interface: DisplayA2uiOptions ​

Defined in: mcp/a2ui.ts:55

Extends ​

  • A2uiEmitOptions

Properties ​

surfaceId? ​

ts
optional surfaceId?: string;

Defined in: a2ui/emit.ts:45

Surface id. Must be unique for the renderer's lifetime.

Default ​

ts
'prefab'

Inherited from ​

ts
A2uiEmitOptions.surfaceId

catalogId? ​

ts
optional catalogId?: string;

Defined in: a2ui/emit.ts:50

Catalog the surface's components are drawn from.

Default ​

ts
the A2UI Basic catalog

Inherited from ​

ts
A2uiEmitOptions.catalogId

stream? ​

ts
optional stream?: boolean;

Defined in: a2ui/emit.ts:57

Split the output into createSurface + updateComponents + updateDataModel instead of inlining everything into createSurface. Streaming transports want the split so the renderer can paint early; a single stored payload does not.

Default ​

ts
false

Inherited from ​

ts
A2uiEmitOptions.stream

sendDataModel? ​

ts
optional sendDataModel?: boolean;

Defined in: a2ui/emit.ts:59

Ask the renderer to echo the data model back on every event.

Default ​

ts
false

Inherited from ​

ts
A2uiEmitOptions.sendDataModel

warn? ​

ts
optional warn?: boolean;

Defined in: a2ui/emit.ts:61

Log degradations and dropped nodes at warn level.

Default ​

ts
false

Inherited from ​

ts
A2uiEmitOptions.warn

uri? ​

ts
optional uri?: string;

Defined in: mcp/a2ui.ts:57

URI stamped on the embedded resource.

Default ​

ts
'a2ui://prefab/surface'

onDiagnostics? ​

ts
optional onDiagnostics?: (diagnostics) => void;

Defined in: mcp/a2ui.ts:63

Called with anything lost in translation. Without it, a degraded or unsupported diagnostic is logged at warn level, because silently shipping a lesser UI is the failure mode worth making noisy.

Parameters ​

ParameterType
diagnosticsA2uiDiagnostic[]

Returns ​

void

Released under the MIT License.