Member Junction
    Preparing search index...

    Interface AgentToolResult<P>

    What an agent tool hands back.

    interface AgentToolResult<P = object> {
        Content: string;
        IsError: boolean;
        PayloadChange?: AgentPayloadChangeRequest<P>;
    }

    Type Parameters

    • P = object
    Index

    Properties

    Content: string

    What the model reads, as the call's tool result.

    IsError: boolean

    True when the call failed; the model sees the result as an error and can correct itself.

    PayloadChange?: AgentPayloadChangeRequest<P>

    The state change this call makes, applied before the next call on the turn runs. Ignored when IsError is true. A change outside the agent's PayloadSelfWritePaths is rejected whole and reported to the model as an error.