Databricks SDK for JavaScript
    Preparing search index...

    Interface Tool

    interface Tool {
        description?: string;
        id?: string;
        name?: string;
        spec?:
            | { $case: "genieSpace"; genieSpace: GenieSpace }
            | { $case: "knowledgeAssistant"; knowledgeAssistant: KnowledgeAssistant }
            | { $case: "ucFunction"; ucFunction: UcFunction }
            | { $case: "app"; app: App }
            | { $case: "volume"; volume: Volume }
            | { $case: "ucConnection"; ucConnection: UcConnection };
        toolId?: string;
        toolType?: string;
    }
    Index

    Properties

    description? id? name? spec? toolId? toolType?

    Properties

    description?: string

    Description of what this tool does (user-facing).

    id?: string

    Deprecated: Use tool_id instead.

    name?: string

    Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

    spec?:
        | { $case: "genieSpace"; genieSpace: GenieSpace }
        | { $case: "knowledgeAssistant"; knowledgeAssistant: KnowledgeAssistant }
        | { $case: "ucFunction"; ucFunction: UcFunction }
        | { $case: "app"; app: App }
        | { $case: "volume"; volume: Volume }
        | { $case: "ucConnection"; ucConnection: UcConnection }

    Specification for the tool type.

    toolId?: string

    User specified id of the Tool.

    toolType?: string

    Tool type. Must be one of: "genie_space", "knowledge_assistant", "uc_function", "uc_connection", "uc_mcp", "app", "volume", "dashboard", "serving_endpoint", "table", "vector_search_index", "catalog", "schema", "supervisor_agent", "databricks_web_search", "skill". The legacy values "lakeview_dashboard", "uc_table", and "web_search" are also accepted and remain equivalent to "dashboard", "table", and "databricks_web_search" respectively. The "databricks_web_search" tool_type maps to the web_search spec field.

    Settings

    Member Visibility

    On This Page

    Properties