MCPToolboxTool interface

包:

@azure/ai-projects

一个存储在工具箱中的MCP工具。

扩展

ToolboxTool

属性

allowed_callers
allowed_tools
authorization	OAuth 访问令牌可用于远程 MCP 服务器，可自定义 MCP 服务器 URL 或服务连接器。 你的应用程序必须处理OAuth授权流程，并在这里提供令牌。
connector_id	服务连接器的标识符，比如ChatGPT中的连接器。 必须提供其中一个 server_url、 connector_id或 tunnel_id 。 点击这里了解更多关于服务连接器的信息。 目前支持 connector_id 的数值有： Dropbox： connector_dropbox Gmail： connector_gmail 谷歌日历： connector_googlecalendar Google Drive： connector_googledrive Microsoft Teams：connector_microsoftteams Outlook 日历：connector_outlookcalendar Outlook 电子邮件：connector_outlookemail SharePoint：connector_sharepoint
defer_loading	该MCP工具是否被推迟并通过工具搜索发现。
headers
project_connection_id	MCP 服务器的project中的连接 ID。 该连接存储连接到 MCP 服务器所需的身份验证和其他连接详细信息。
require_approval
server_description	可选的MCP服务器描述，用于提供更多上下文。
server_label	此 MCP 服务器的标签，用于在工具调用中标识它。
server_url	MCP 服务器的 URL。 必须提供其中一个 server_url、 connector_id或 tunnel_id 。
tunnel_id	用安全MCP隧道ID代替直接服务器URL。 必须提供其中一个 server_url、 connector_id或 tunnel_id 。
type	判别器可能的值：code_interpreter、file_search、web_search、mcp、azure_ai_search、openapi、a2a_preview、browser_automation_preview、reminder_preview、work_iq_preview、fabric_iq_preview、toolbox_search_preview、toolbox_search

继承属性

description	可选的用户自定义描述，用于该工具或配置。
name	该工具或配置可选择用户自定义名称。
tool_configs	每个工具的配置图。 键是工具名称或 * （通用默认）。 分辨率排序：精确的刀具名称匹配优先于 *。 未知的工具名称在运行时会被无声地忽略。

属性详细信息

allowed_callers

allowed_callers?: CallableToolAllowedCaller[]

属性值

CallableToolAllowedCaller[]

allowed_tools

allowed_tools?: string[] | MCPToolFilter

属性值

string[] | MCPToolFilter

authorization

OAuth 访问令牌可用于远程 MCP 服务器，可自定义 MCP 服务器 URL 或服务连接器。 你的应用程序必须处理OAuth授权流程，并在这里提供令牌。

authorization?: string

属性值

string

connector_id

服务连接器的标识符，比如ChatGPT中的连接器。 必须提供其中一个 server_url、 connector_id或 tunnel_id 。 点击这里了解更多关于服务连接器的信息。 目前支持 connector_id 的数值有：

• Dropbox： connector_dropbox
• Gmail： connector_gmail
• 谷歌日历： connector_googlecalendar
• Google Drive： connector_googledrive
• Microsoft Teams：connector_microsoftteams
• Outlook 日历：connector_outlookcalendar
• Outlook 电子邮件：connector_outlookemail
• SharePoint：connector_sharepoint

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

属性值

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

defer_loading

该MCP工具是否被推迟并通过工具搜索发现。

defer_loading?: boolean

属性值

boolean

headers

headers?: Record<string, string>

属性值

Record<string, string>

project_connection_id

MCP 服务器的project中的连接 ID。 该连接存储连接到 MCP 服务器所需的身份验证和其他连接详细信息。

project_connection_id?: string

属性值

string

require_approval

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

属性值

MCPToolRequireApproval | "always" | "never"

server_description

可选的MCP服务器描述，用于提供更多上下文。

server_description?: string

属性值

string

server_label

此 MCP 服务器的标签，用于在工具调用中标识它。

server_label: string

属性值

string

server_url

MCP 服务器的 URL。 必须提供其中一个 server_url、 connector_id或 tunnel_id 。

server_url?: string

属性值

string

tunnel_id

用安全MCP隧道ID代替直接服务器URL。 必须提供其中一个 server_url、 connector_id或 tunnel_id 。

tunnel_id?: string

属性值

string

type

判别器可能的值：code_interpreter、file_search、web_search、mcp、azure_ai_search、openapi、a2a_preview、browser_automation_preview、reminder_preview、work_iq_preview、fabric_iq_preview、toolbox_search_preview、toolbox_search

type: "mcp"

属性值

"mcp"

继承属性详细信息

description

可选的用户自定义描述，用于该工具或配置。

description?: string

属性值

string

继承自ToolboxTool.description

name

该工具或配置可选择用户自定义名称。

name?: string

属性值

string

继承自ToolboxTool.name

tool_configs

每个工具的配置图。 键是工具名称或 * （通用默认）。 分辨率排序：精确的刀具名称匹配优先于 *。 未知的工具名称在运行时会被无声地忽略。

tool_configs?: Record<string, ToolConfig>

属性值

Record<string, ToolConfig>

继承自ToolboxTool.tool_configs