ART Framework API Docs
    Preparing search index...

    Interface BlockingToolConfig

    Configuration for blocking tools in the ToolSchema.

    This is added to ToolSchema when executionMode is 'blocking'. It defines how the tool interacts with the HITL system.

    interface BlockingToolConfig {
        allowRetryOnReject?: boolean;
        approvalPrompt?: string;
        category?: string;
        completesOnApproval?: boolean;
        feedbackSchema?: HITLFeedbackSchema;
        riskLevel?: "low" | "medium" | "high" | "critical";
        timeoutMs?: number;
    }
    Index

    Properties

    allowRetryOnReject? approvalPrompt? category? completesOnApproval? feedbackSchema? riskLevel? timeoutMs?

    Properties

    allowRetryOnReject?: boolean

    Whether rejection allows retry with modified arguments. If true, rejection doesn't fail the step but allows re-planning.

    true
    approvalPrompt?: string

    Message to show in the approval dialog. Can include {{variable}} placeholders that will be replaced with values from the tool's input arguments.

    category?: string

    Category of the blocking action for UI grouping. Examples: 'destructive', 'financial', 'external', 'sensitive'

    completesOnApproval?: boolean

    Whether the tool auto-completes successfully when approved. If true (default), approval = success with feedback as output. If false, the tool's execute() is called again with hitlContext.

    true
    feedbackSchema?: HITLFeedbackSchema

    The schema for feedback this tool expects. If not provided, defaults to a simple confirm schema.

    riskLevel?: "low" | "medium" | "high" | "critical"

    Risk level for UI styling/warnings.

    timeoutMs?: number

    Timeout in milliseconds for user response. If exceeded, the tool fails with a timeout error.

    undefined (no timeout)

    Settings

    Member Visibility

    On This Page

    Properties