Skip to content

@maxhealth.tech/prefab / mcp / A2uiResourceOptions

Interface: A2uiResourceOptions

Defined in: mcp/a2ui.ts:113

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:115

Resource URI. Must start with a2ui://.

Default

ts
'a2ui://prefab/surface'

title?

ts
optional title?: string;

Defined in: mcp/a2ui.ts:117

Resource title shown in listings.

Default

ts
'Prefab Surface'

description?

ts
optional description?: string;

Defined in: mcp/a2ui.ts:119

Human-readable description for the listing.


cache?

ts
optional cache?: McpCacheHint;

Defined in: mcp/a2ui.ts:121

Cache fields for the resources/read result (SEP-2549).


onDiagnostics?

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

Defined in: mcp/a2ui.ts:123

See DisplayA2uiOptions.onDiagnostics.

Parameters

ParameterType
diagnosticsA2uiDiagnostic[]

Returns

void

Released under the MIT License.