ToolboxTool interface

Package:

@azure/ai-projects

An abstract representation of a tool stored in a toolbox.

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 discriminator possible values: code_interpreter, file_search, web_search, mcp, azure_ai_search, openapi, a2a_preview, browser_automation_preview, reminder_preview, work_iq_preview, fabric_iq_preview, 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 discriminator possible values: code_interpreter, file_search, web_search, mcp, azure_ai_search, openapi, a2a_preview, browser_automation_preview, reminder_preview, work_iq_preview, fabric_iq_preview, toolbox_search_preview

type: ToolboxToolType

Property Value

ToolboxToolType