ProjectsAgentsModelFactory.VoiceAgentMcpTool Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An MCP tool available to a voice agent. Server endpoints use server_url; connector and tunnel identifiers are not supported.
public static Azure.AI.Projects.Agents.VoiceAgentMcpTool VoiceAgentMcpTool(string serverLabel = default, Uri serverUrl = default, string authorization = default, string serverDescription = default, System.Collections.Generic.IDictionary<string,string> headers = default, OpenAI.Responses.McpToolFilter allowedTools = default, System.Collections.Generic.IEnumerable<Azure.AI.Projects.Agents.CallableToolAllowedCaller> allowedCallers = default, BinaryData requireApprovalInternal = default, bool? deferLoading = default, string projectConnectionId = default, System.Collections.Generic.IDictionary<string,Azure.AI.Extensions.OpenAI.ToolConfig> toolConfigs = default, Azure.AI.Projects.Agents.VoiceAgentToolResponseScheduling? responseScheduling = default);
static member VoiceAgentMcpTool : string * Uri * string * string * System.Collections.Generic.IDictionary<string, string> * OpenAI.Responses.McpToolFilter * seq<Azure.AI.Projects.Agents.CallableToolAllowedCaller> * BinaryData * Nullable<bool> * string * System.Collections.Generic.IDictionary<string, Azure.AI.Extensions.OpenAI.ToolConfig> * Nullable<Azure.AI.Projects.Agents.VoiceAgentToolResponseScheduling> -> Azure.AI.Projects.Agents.VoiceAgentMcpTool
Public Shared Function VoiceAgentMcpTool (Optional serverLabel As String = Nothing, Optional serverUrl As Uri = Nothing, Optional authorization As String = Nothing, Optional serverDescription As String = Nothing, Optional headers As IDictionary(Of String, String) = Nothing, Optional allowedTools As McpToolFilter = Nothing, Optional allowedCallers As IEnumerable(Of CallableToolAllowedCaller) = Nothing, Optional requireApprovalInternal As BinaryData = Nothing, Optional deferLoading As Nullable(Of Boolean) = Nothing, Optional projectConnectionId As String = Nothing, Optional toolConfigs As IDictionary(Of String, ToolConfig) = Nothing, Optional responseScheduling As Nullable(Of VoiceAgentToolResponseScheduling) = Nothing) As VoiceAgentMcpTool
Parameters
- serverLabel
- String
A label for this MCP server, used to identify it in tool calls.
- serverUrl
- Uri
The URL for the MCP server. One of server_url, connector_id, or
tunnel_id must be provided.
- authorization
- String
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.
- serverDescription
- String
Optional description of the MCP server, used to provide more context.
- headers
- IDictionary<String,String>
- allowedTools
- OpenAI.Responses.McpToolFilter
- allowedCallers
- IEnumerable<CallableToolAllowedCaller>
- requireApprovalInternal
- BinaryData
- projectConnectionId
- String
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.
- toolConfigs
- IDictionary<String,ToolConfig>
Deprecated. This property is deprecated and will be removed in a future version.
- responseScheduling
- Nullable<VoiceAgentToolResponseScheduling>
When the MCP invocation creates a follow-up response. Defaults to when_idle.
Returns
A new VoiceAgentMcpTool instance for mocking.