TanStack

UIResourceEvent

Defined in: packages/ai/src/types.ts:1473

Emitted when an MCP tool returns a ui:// resource (MCP Apps). Reconciled into a UIResourcePart on the assistant UIMessage. Never enters model input.

Extends

Properties

metadata?

ts
optional metadata?: Record<string, any>;

Defined in: packages/ai/src/types.ts:1390

Inherited from

CustomEvent.metadata


name

ts
name: "ui-resource";

Defined in: packages/ai/src/types.ts:1474

Overrides

ts
CustomEvent.name

type

ts
type: "CUSTOM";

Defined in: packages/ai/src/types.ts:1389

Inherited from

CustomEvent.type


value

ts
value: object;

Defined in: packages/ai/src/types.ts:1475

meta?

ts
optional meta?: Record<string, unknown>;

resource

ts
resource: object;
resource.blob?
ts
optional blob?: string;
resource.mimeType
ts
mimeType: string;
resource.text?
ts
optional text?: string;
resource.uri
ts
uri: string;

serverId?

ts
optional serverId?: string;

toolCallId

ts
toolCallId: string;

toolName

ts
toolName: string;

Overrides

ts
CustomEvent.value