ART Framework API Docs
    Preparing search index...

    Interface DisplayToolConfig

    Configuration for display tools in the ToolSchema.

    This is added to ToolSchema when executionMode is 'display'. Display tools render UI without producing traditional results.

    interface DisplayToolConfig {
        componentType?: string;
        dataSchema?: Record<string, unknown>;
        displayMode?: "persistent" | "ephemeral" | "modal";
        interactive?: boolean;
    }
    Index

    Properties

    componentType? dataSchema? displayMode? interactive?

    Properties

    componentType?: string

    The type of UI component this tool renders.

    dataSchema?: Record<string, unknown>

    Schema for the data this display component expects.

    displayMode?: "persistent" | "ephemeral" | "modal"

    Whether the display persists or is ephemeral.

    'persistent'
    interactive?: boolean

    Whether this display supports user interaction. If true, interactions may generate new messages.

    false

    Settings

    Member Visibility

    On This Page

    Properties