WebIQPreviewToolboxTool interface

Package:

@azure/ai-projects

A WebIQ tool stored in a toolbox.

Extends

ToolboxTool

Properties

project_connection_id	The ID of the WebIQ project connection.
require_approval	Whether the agent requires approval before executing actions. When omitted, the service defaults to "always".
server_label	The label of the WebIQ MCP server to connect to. When omitted, the service defaults to connection name extracted from project_connection_id.
type	The toolbox tool type. Always web_iq_preview for a WebIQ tool.

Inherited 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.

Property Details

project_connection_id

The ID of the WebIQ project connection.

project_connection_id: string

Property Value

string

require_approval

Whether the agent requires approval before executing actions. When omitted, the service defaults to "always".

require_approval?: string | MCPToolRequireApproval

Property Value

string | MCPToolRequireApproval

server_label

The label of the WebIQ MCP server to connect to. When omitted, the service defaults to connection name extracted from project_connection_id.

server_label?: string

Property Value

string

type

The toolbox tool type. Always web_iq_preview for a WebIQ tool.

type: "web_iq_preview"

Property Value

"web_iq_preview"

Inherited Property Details

description

Optional user-defined description for this tool or configuration.

description?: string

Property Value

string

Inherited From ToolboxTool.description

name

Optional user-defined name for this tool or configuration.

name?: string

Property Value

string

Inherited From ToolboxTool.name

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>

Inherited From ToolboxTool.tool_configs