MCPTool interface

Package:

@azure/ai-projects

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

Extends

Tool

Properties

allowed_tools
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.
connector_id	Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here. Currently supported connector_id values are: Dropbox: connector_dropbox Gmail: connector_gmail Google Calendar: connector_googlecalendar Google Drive: connector_googledrive Microsoft Teams: connector_microsoftteams Outlook Calendar: connector_outlookcalendar Outlook Email: connector_outlookemail SharePoint: connector_sharepoint
headers
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
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. One of server_url or connector_id must be provided.
type	The type of the MCP tool. Always mcp.

Property Details

allowed_tools

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

connector_id

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here. Currently supported connector_id values are:

• Dropbox: connector_dropbox
• Gmail: connector_gmail
• Google Calendar: connector_googlecalendar
• Google Drive: connector_googledrive
• Microsoft Teams: connector_microsoftteams
• Outlook Calendar: connector_outlookcalendar
• Outlook Email: connector_outlookemail
• SharePoint: connector_sharepoint

connector_id?: "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint"

Property Value

"connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint"

headers

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

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

Property Value

MCPToolRequireApproval | "always" | "never"

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. One of server_url or connector_id must be provided.

server_url?: string

Property Value

string

type

The type of the MCP tool. Always mcp.

type: "mcp"

Property Value

"mcp"