ToolboxSearchPreviewTool interface

Package:

@azure/ai-projects

A tool for searching over the agent's toolbox. When present, deferred tools are hidden from tools/list and only discoverable via search_tools queries at runtime.

Extends

Tool

Properties

description	Optional user-defined description for this tool or configuration.
name	Optional user-defined name for this tool or configuration.
tool_configs	Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.
type	The type of the tool. Always toolbox_search_preview.

Property Details

description

Optional user-defined description for this tool or configuration.

description?: string

Property Value

string

name

Optional user-defined name for this tool or configuration.

name?: string

Property Value

string

tool_configs

Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

tool_configs?: Record<string, ToolConfig>

Property Value

Record<string, ToolConfig>

type

The type of the tool. Always toolbox_search_preview.

type: "toolbox_search_preview"

Property Value

"toolbox_search_preview"