Skip to content

Interface: ChatToolResult

Defined in: packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:185

What a tool invocation returns.

Properties

PropertyTypeDescriptionDefined in
render?ChatAugmentationRich blocks to render for this tool's output (image, sources, …).packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:187
reply?stringThe user-facing reply text shown for this turn. On the chrome-ai path the model is NOT re-invoked after a tool runs, so this is the literal reply — keeping it honest (it can't over-claim "I deleted it"). Omit it when render carries an unresolved confirmation (the turn stays text-free until the user responds).packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:195
result?stringThe model-facing value. Fed back to the model whenever one runs after the tool: the aiSdk cloud loop always, and the chrome-ai path when agentic round-tripping is enabled. Ignored on a deterministic chrome-ai tool turn (where reply is shown verbatim).packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:202

Matterway Assistant SDK Documentation