A2AToolboxTool interface

Package:

@azure/ai-projects

An A2A tool stored in a toolbox.

Extends

ToolboxTool

Properties

a2a_version	The A2A protocol version supported by the agent.
agent_card_path	The path to the agent card relative to the base_url. If not provided, defaults to /.well-known/agent-card.json
base_url	Base URL of the agent.
project_connection_id	The connection ID in the project for the A2A server. The connection stores authentication and other connection details needed to connect to the A2A server.
send_credentials_for_agent_card	When true, Foundry sends its credentials when fetching the remote agent's Agent Card. The service defaults to false if a value is not specified by the caller (anonymous fetch).
type	The type of the A2A toolbox tool. Always a2a.

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

a2a_version

The A2A protocol version supported by the agent.

a2a_version: "1.0"

Property Value

"1.0"

agent_card_path

The path to the agent card relative to the base_url. If not provided, defaults to /.well-known/agent-card.json

agent_card_path?: string

Property Value

string

base_url

Base URL of the agent.

base_url?: string

Property Value

string

project_connection_id

The connection ID in the project for the A2A server. The connection stores authentication and other connection details needed to connect to the A2A server.

project_connection_id?: string

Property Value

string

send_credentials_for_agent_card

When true, Foundry sends its credentials when fetching the remote agent's Agent Card. The service defaults to false if a value is not specified by the caller (anonymous fetch).

send_credentials_for_agent_card?: boolean

Property Value

boolean

type

The type of the A2A toolbox tool. Always a2a.

type: "a2a"

Property Value

"a2a"

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