ToolResultEnvelope
Interface: ToolResultEnvelope
Defined in: src/core/agent/toolEffects.ts:108
What a tool handler returns to opt into the channel:
{ content, effects, status? }. content is what the model reads (any
value — strings pass through, objects stringify exactly as a bare return
would). Returning anything else keeps today's path, byte for byte.
effects is REQUIRED — it is the envelope marker itself. The recognizer
refuses to treat a value without an effects array as an envelope (that
strictness IS the zero-cost guarantee: { content, status: 'success' }
is a shape a domain object could already have), so the type says exactly
what the recognizer accepts. Status-only is spelled effects: [] — the
explicit marker when only status matters.
Properties
content
readonlycontent:unknown
Defined in: src/core/agent/toolEffects.ts:109
effects
readonlyeffects: readonlyProposedEffect[]
Defined in: src/core/agent/toolEffects.ts:110
status?
readonlyoptionalstatus?:ToolResultStatus
Defined in: src/core/agent/toolEffects.ts:111
