VoiceAgentMcpTool interface

Package:

@azure/ai-projects

An MCP tool available to a voice agent.

Extends

VoiceAgentTool

Properties

allowed_callers	The callers that may invoke tools exposed by this MCP server.
allowed_tools	The tool names or filter that determines which tools from the MCP server are available to the voice agent.
authorization	An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.
defer_loading	Whether this MCP tool is deferred and discovered via tool search.
headers	HTTP headers to include in requests to the MCP server.
project_connection_id	The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server.
require_approval	The approval policy for MCP tool calls, specified globally or for selected tools.
response_scheduling	When the MCP invocation creates a follow-up response. Defaults to when_idle.
server_description	Optional description of the MCP server, used to provide more context.
server_label	A label for this MCP server, used to identify it in tool calls.
server_url	The URL for the MCP server.
tool_configs	Deprecated. This property is deprecated and will be removed in a future version.
type	The tool type. Always mcp for tools exposed by an MCP server.

Property Details

allowed_callers

The callers that may invoke tools exposed by this MCP server.

allowed_callers?: CallableToolAllowedCaller[]

Property Value

CallableToolAllowedCaller[]

allowed_tools

The tool names or filter that determines which tools from the MCP server are available to the voice agent.

allowed_tools?: string[] | MCPToolFilter

Property Value

string[] | MCPToolFilter

authorization

An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.

authorization?: string

Property Value

string

defer_loading

Whether this MCP tool is deferred and discovered via tool search.

defer_loading?: boolean

Property Value

boolean

headers

HTTP headers to include in requests to the MCP server.

headers?: Record<string, string>

Property Value

Record<string, string>

project_connection_id

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

project_connection_id?: string

Property Value

string

require_approval

The approval policy for MCP tool calls, specified globally or for selected tools.

require_approval?: MCPToolRequireApproval | "always" | "never"

Property Value

MCPToolRequireApproval | "always" | "never"

response_scheduling

When the MCP invocation creates a follow-up response. Defaults to when_idle.

response_scheduling?: VoiceAgentToolResponseScheduling

Property Value

VoiceAgentToolResponseScheduling

server_description

Optional description of the MCP server, used to provide more context.

server_description?: string

Property Value

string

server_label

A label for this MCP server, used to identify it in tool calls.

server_label: string

Property Value

string

server_url

The URL for the MCP server.

server_url?: string

Property Value

string

tool_configs

Deprecated. This property is deprecated and will be removed in a future version.

tool_configs?: Record<string, ToolConfig>

Property Value

Record<string, ToolConfig>

type

The tool type. Always mcp for tools exposed by an MCP server.

type: "mcp"

Property Value

"mcp"