MCPToolboxTool interface

Package:
@azure/ai-projects

An MCP tool stored in a toolbox.

Extends
ToolboxTool

Properties

allowed_callers

The callers that may invoke this MCP toolbox tool, either directly or programmatically.
allowed_tools

The MCP tools available for use, specified by name or a tool filter.
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, connector_id, or tunnel_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
defer_loading

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

Custom 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

Whether MCP tool calls require approval, either for all tools or for tools selected by filters.
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, connector_id, or tunnel_id must be provided.
tunnel_id

The Secure MCP Tunnel ID to use instead of a direct server URL. One of server_url, connector_id, or tunnel_id must be provided.
type

The type of the MCP toolbox tool. Always mcp.

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

allowed_callers

The callers that may invoke this MCP toolbox tool, either directly or programmatically.

allowed_callers?: CallableToolAllowedCaller[]

Property Value

CallableToolAllowedCaller[]

allowed_tools

The MCP tools available for use, specified by name or a tool filter.

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, connector_id, or tunnel_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"

defer_loading

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

defer_loading?: boolean

Property Value

boolean

headers

Custom 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

Whether MCP tool calls require approval, either for all tools or for tools selected by filters.

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, connector_id, or tunnel_id must be provided.

server_url?: string

Property Value

string

tunnel_id

The Secure MCP Tunnel ID to use instead of a direct server URL. One of server_url, connector_id, or tunnel_id must be provided.

tunnel_id?: string

Property Value

string

type

The type of the MCP toolbox tool. Always mcp.

type: "mcp"

Property Value

"mcp"

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