MCPToolboxTool interface

Pacote:

@azure/ai-projects

Uma ferramenta MCP armazenada em uma caixa de ferramentas.

Extends

ToolboxTool

Propriedades

allowed_tools
authorization	Um token de acesso OAuth que pode ser usado com um servidor MCP remoto, seja com uma URL personalizada de servidor MCP ou um conector de serviço. Sua aplicação deve lidar com o fluxo de autorização do OAuth e fornecer o token aqui.
connector_id	Identificador para conectores de serviço, como aqueles disponíveis no ChatGPT. Um de server_url, connector_id, ou tunnel_id deve ser fornecido. Saiba mais sobre conectores de serviço aqui. Os valores com connector_id suporte no momento são: Dropbox: connector_dropbox Gmail: connector_gmail Google Calendário: connector_googlecalendar Google Drive: connector_googledrive Microsoft Teams:connector_microsoftteams Outlook Calendário: connector_outlookcalendar Outlook E-mail: connector_outlookemail Sharepoint: connector_sharepoint
defer_loading	Se essa ferramenta MCP é adiada e descoberta por meio de busca de ferramentas.
headers
project_connection_id	A ID da conexão no project para o servidor MCP. A conexão armazena a autenticação e outros detalhes de conexão necessários para se conectar ao servidor MCP.
require_approval
server_description	Descrição opcional do servidor MCP, usada para fornecer mais contexto.
server_label	Um rótulo para esse servidor MCP, usado para identificá-lo em chamadas de ferramenta.
server_url	A URL do servidor MCP. Um de server_url, connector_id, ou tunnel_id deve ser fornecido.
tunnel_id	O ID do Túnel MCP Seguro para usar em vez de uma URL direta do servidor. Um de server_url, connector_id, ou tunnel_id deve ser fornecido.
type	Os valores possíveis do discriminador: 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

Propriedades herdadas

description	Descrição opcional definida pelo usuário para esta ferramenta ou configuração.
name	Nome opcional definido pelo usuário para essa ferramenta ou configuração.
tool_configs	Mapa de configuração por ferramenta. Chaves são nomes de ferramentas ou * (padrão abrangente). Ordem de resolução: a correspondência exata do nome da ferramenta tem prioridade sobre *. Nomes de ferramentas desconhecidos são silenciosamente ignorados durante a execução.

Detalhes da propriedade

allowed_tools

allowed_tools?: string[] | MCPToolFilter

Valor da propriedade

string[] | MCPToolFilter

authorization

Um token de acesso OAuth que pode ser usado com um servidor MCP remoto, seja com uma URL personalizada de servidor MCP ou um conector de serviço. Sua aplicação deve lidar com o fluxo de autorização do OAuth e fornecer o token aqui.

authorization?: string

Valor da propriedade

string

connector_id

Identificador para conectores de serviço, como aqueles disponíveis no ChatGPT. Um de server_url, connector_id, ou tunnel_id deve ser fornecido. Saiba mais sobre conectores de serviço aqui. Os valores com connector_id suporte no momento são:

• Dropbox: connector_dropbox
• Gmail: connector_gmail
• Google Calendário: connector_googlecalendar
• Google Drive: connector_googledrive
• Microsoft Teams:connector_microsoftteams
• Outlook Calendário: connector_outlookcalendar
• Outlook E-mail: connector_outlookemail
• Sharepoint: connector_sharepoint

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

Valor da propriedade

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

defer_loading

Se essa ferramenta MCP é adiada e descoberta por meio de busca de ferramentas.

defer_loading?: boolean

Valor da propriedade

boolean

headers

headers?: Record<string, string>

Valor da propriedade

Record<string, string>

project_connection_id

A ID da conexão no project para o servidor MCP. A conexão armazena a autenticação e outros detalhes de conexão necessários para se conectar ao servidor MCP.

project_connection_id?: string

Valor da propriedade

string

require_approval

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

Valor da propriedade

MCPToolRequireApproval | "always" | "never"

server_description

Descrição opcional do servidor MCP, usada para fornecer mais contexto.

server_description?: string

Valor da propriedade

string

server_label

Um rótulo para esse servidor MCP, usado para identificá-lo em chamadas de ferramenta.

server_label: string

Valor da propriedade

string

server_url

A URL do servidor MCP. Um de server_url, connector_id, ou tunnel_id deve ser fornecido.

server_url?: string

Valor da propriedade

string

tunnel_id

O ID do Túnel MCP Seguro para usar em vez de uma URL direta do servidor. Um de server_url, connector_id, ou tunnel_id deve ser fornecido.

tunnel_id?: string

Valor da propriedade

string

type

Os valores possíveis do discriminador: 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"

Valor da propriedade

"mcp"

Detalhes das propriedades herdadas

description

Descrição opcional definida pelo usuário para esta ferramenta ou configuração.

description?: string

Valor da propriedade

string

Herdado deToolboxTool.description

name

Nome opcional definido pelo usuário para essa ferramenta ou configuração.

name?: string

Valor da propriedade

string

Herdado deToolboxTool.name

tool_configs

Mapa de configuração por ferramenta. Chaves são nomes de ferramentas ou * (padrão abrangente). Ordem de resolução: a correspondência exata do nome da ferramenta tem prioridade sobre *. Nomes de ferramentas desconhecidos são silenciosamente ignorados durante a execução.

tool_configs?: Record<string, ToolConfig>

Valor da propriedade

Record<string, ToolConfig>

Herdado deToolboxTool.tool_configs