FoundryAITool.CreateMcpTool Method

Definition

Namespace:: Microsoft.Agents.AI.AzureAI

Assembly:: Microsoft.Agents.AI.AzureAI.dll

Package:: Microsoft.Agents.AI.AzureAI v1.0.0-rc5

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.

Overloads

Name	Description
CreateMcpTool(String, McpToolConnectorId, String, String, IDictionary<String,String>, McpToolFilter, McpToolCallApprovalPolicy)	Creates an AITool for MCP (Model Context Protocol) server tools using a connector ID.
CreateMcpTool(String, Uri, String, String, IDictionary<String,String>, McpToolFilter, McpToolCallApprovalPolicy)	Creates an AITool for MCP (Model Context Protocol) server tools.

CreateMcpTool(String, McpToolConnectorId, String, String, IDictionary<String,String>, McpToolFilter, McpToolCallApprovalPolicy)

Creates an AITool for MCP (Model Context Protocol) server tools using a connector ID.

public static Microsoft.Extensions.AI.AITool CreateMcpTool(string serverLabel, OpenAI.Responses.McpToolConnectorId connectorId, string? authorizationToken = default, string? serverDescription = default, System.Collections.Generic.IDictionary<string,string>? headers = default, OpenAI.Responses.McpToolFilter? allowedTools = default, OpenAI.Responses.McpToolCallApprovalPolicy? toolCallApprovalPolicy = default);

static member CreateMcpTool : string * OpenAI.Responses.McpToolConnectorId * string * string * System.Collections.Generic.IDictionary<string, string> * OpenAI.Responses.McpToolFilter * OpenAI.Responses.McpToolCallApprovalPolicy -> Microsoft.Extensions.AI.AITool

Public Shared Function CreateMcpTool (serverLabel As String, connectorId As McpToolConnectorId, Optional authorizationToken As String = Nothing, Optional serverDescription As String = Nothing, Optional headers As IDictionary(Of String, String) = Nothing, Optional allowedTools As McpToolFilter = Nothing, Optional toolCallApprovalPolicy As McpToolCallApprovalPolicy = Nothing) As AITool

Parameters

serverLabel: String

The label for the MCP server.

connectorId: OpenAI.Responses.McpToolConnectorId

The connector ID for the MCP server.

authorizationToken: String

Optional authorization token.

serverDescription: String

Optional server description.

headers: IDictionary<String,String>

Optional custom headers.

allowedTools: OpenAI.Responses.McpToolFilter

Optional filter for allowed tools.

toolCallApprovalPolicy: OpenAI.Responses.McpToolCallApprovalPolicy

Optional tool call approval policy.

Returns

AITool

An AITool for MCP server tools.

Applies to

CreateMcpTool(String, Uri, String, String, IDictionary<String,String>, McpToolFilter, McpToolCallApprovalPolicy)

Creates an AITool for MCP (Model Context Protocol) server tools.

public static Microsoft.Extensions.AI.AITool CreateMcpTool(string serverLabel, Uri serverUri, string? authorizationToken = default, string? serverDescription = default, System.Collections.Generic.IDictionary<string,string>? headers = default, OpenAI.Responses.McpToolFilter? allowedTools = default, OpenAI.Responses.McpToolCallApprovalPolicy? toolCallApprovalPolicy = default);

static member CreateMcpTool : string * Uri * string * string * System.Collections.Generic.IDictionary<string, string> * OpenAI.Responses.McpToolFilter * OpenAI.Responses.McpToolCallApprovalPolicy -> Microsoft.Extensions.AI.AITool

Public Shared Function CreateMcpTool (serverLabel As String, serverUri As Uri, Optional authorizationToken As String = Nothing, Optional serverDescription As String = Nothing, Optional headers As IDictionary(Of String, String) = Nothing, Optional allowedTools As McpToolFilter = Nothing, Optional toolCallApprovalPolicy As McpToolCallApprovalPolicy = Nothing) As AITool