ADK for TypeScript: API Reference
    Preparing search index...

    Interface ToolNodeConfig

    Options for a ToolNode.

    interface ToolNodeConfig {
        description?: string;
        inputSchema?: SchemaLike;
        isolationScope?: string | true;
        name?: string;
        outputSchema?: SchemaLike;
        rerunOnResume?: boolean;
        retryConfig?: RetryConfig;
        stateSchema?: SchemaLike;
        timeout?: number;
        waitForOutput?: boolean;
    }

    Hierarchy

    Properties

    description?: string

    Human-readable description (used when a node is exposed as a tool).

    inputSchema?: SchemaLike

    Optional schema validating the node input (Zod v3/v4 or genai Schema).

    isolationScope?: string | true

    Runs this node's subtree in an isolated conversation scope: an agent inside it sees only session events carrying the same scope, plus untagged ones. true derives a scope per node run; a string is an explicit shared tag.

    name?: string

    Optional name override; defaults to the tool's name.

    outputSchema?: SchemaLike

    Optional schema validating the node output (Zod v3/v4 or genai Schema).

    rerunOnResume?: boolean

    If true, the node re-executes when a workflow resumes even if it already completed in a prior turn. Default false.

    retryConfig?: RetryConfig

    Optional retry configuration for transient failures.

    stateSchema?: SchemaLike

    Optional schema validating relevant session state (Zod v3/v4 or genai Schema).

    timeout?: number

    Maximum time, in seconds, for this node to complete.

    waitForOutput?: boolean

    If true, the node only produces its output once all of its predecessors have triggered it (fan-in / join semantics). Default false.

    Properties