Skip to content

Type Alias: ChatToolReturn

ts
type ChatToolReturn = 
  | ChatReply
  | ChatUi
  | ChatPlanReturn
  | string
  | Record<string, unknown>
  | void
  | null
  | undefined;

Defined in: packages/sdk/src/renderer/templates/chat-tools.ts:156

What a tool's execute may return:

  • reply — skill-authored, verbatim text (+ optional content);
  • a bare value (string/object) — the AI phrases the reply from it;
  • ui — rendered blocks, no text;
  • plan() — an editable, runnable plan;
  • nothing.

Matterway Assistant SDK Documentation