Skip to content

Interface: CanonicalMessage ​

Defined in: ports/canonical-message.ts:35

Vendor-neutral projection of a conversation turn frame stored alongside rawWireFrame.

Used for cross-model escalations (substituteTombstones: true), turn completion detection, and deterministic tool call orchestration.

Properties ​

PropertyModifierTypeDescriptionDefined in
rolereadonly"tool" | "system" | "user" | "assistant"Role of the message author in the conversation transcript.ports/canonical-message.ts:37
toolCalls?readonlyreadonly CanonicalToolCall[]Optional assistant tool call requests emitted in this turn.ports/canonical-message.ts:41
toolResults?readonlyreadonly CanonicalToolResult[]Optional tool execution results paired in this turn.ports/canonical-message.ts:43
visibleTextreadonlystringVisible plain-text content of the message.ports/canonical-message.ts:39

Released under the MIT License.