MCPToolboxTool interface

Pacote:

@azure/ai-projects

Uma ferramenta MCP guardada numa caixa de ferramentas.

Extends

ToolboxTool

Propriedades

allowed_callers	Os chamadores que podem invocar esta ferramenta MCP, seja diretamente ou programaticamente.
allowed_tools	As ferramentas MCP disponíveis para uso, especificadas pelo nome ou por um filtro de ferramentas.
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. A sua aplicação deve gerir o fluxo de autorização OAuth e fornecer o token aqui.
connector_id	Identificador para conectores de serviço, como os disponíveis no ChatGPT. Um dos server_url, connector_id, ou tunnel_id deve ser fornecido. Saiba mais sobre conectores de serviço aqui. Os valores atualmente suportados connector_id 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 Email:connector_outlookemail SharePoint:connector_sharepoint
defer_loading	Se esta ferramenta MCP é adiada e descoberta através de pesquisa de ferramentas.
headers	Cabeçalhos HTTP personalizados para incluir nos pedidos ao servidor MCP.
project_connection_id	O ID de ligação no project para o servidor MCP. A conexão armazena autenticação e outros detalhes de conexão necessários para se conectar ao servidor MCP.
require_approval	Se as chamadas de ferramenta MCP requerem aprovação, seja para todas as ferramentas ou para ferramentas selecionadas por filtros.
server_description	Descrição opcional do servidor MCP, usada para fornecer mais contexto.
server_label	Um rótulo para este servidor MCP, usado para identificá-lo em chamadas de ferramentas.
server_url	A URL do servidor MCP. Um dos server_url, connector_id, ou tunnel_id deve ser fornecido.
tunnel_id	O ID do Túnel MCP Seguro para usar em vez de um URL direto do servidor. Um dos server_url, connector_id, ou tunnel_id deve ser fornecido.
type	O tipo de ferramenta da caixa de ferramentas MCP. Sempre mcp.

Propriedades Herdadas

description	Descrição opcional definida pelo utilizador para esta ferramenta ou configuração.
name	Nome opcional definido pelo utilizador para esta ferramenta ou configuração.
tool_configs	Mapa de configuração por ferramenta. As 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 em tempo de execução.

Detalhes de Propriedade

allowed_callers

Os chamadores que podem invocar esta ferramenta MCP, seja diretamente ou programaticamente.

allowed_callers?: CallableToolAllowedCaller[]

Valor de Propriedade

CallableToolAllowedCaller[]

allowed_tools

As ferramentas MCP disponíveis para uso, especificadas pelo nome ou por um filtro de ferramentas.

allowed_tools?: string[] | MCPToolFilter

Valor de 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. A sua aplicação deve gerir o fluxo de autorização OAuth e fornecer o token aqui.

authorization?: string

Valor de Propriedade

string

connector_id

Identificador para conectores de serviço, como os disponíveis no ChatGPT. Um dos server_url, connector_id, ou tunnel_id deve ser fornecido. Saiba mais sobre conectores de serviço aqui. Os valores atualmente suportados connector_id 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 Email:connector_outlookemail
• SharePoint:connector_sharepoint

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

Valor de Propriedade

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

defer_loading

Se esta ferramenta MCP é adiada e descoberta através de pesquisa de ferramentas.

defer_loading?: boolean

Valor de Propriedade

boolean

headers

Cabeçalhos HTTP personalizados para incluir nos pedidos ao servidor MCP.

headers?: Record<string, string>

Valor de Propriedade

Record<string, string>

project_connection_id

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

project_connection_id?: string

Valor de Propriedade

string

require_approval

Se as chamadas de ferramenta MCP requerem aprovação, seja para todas as ferramentas ou para ferramentas selecionadas por filtros.

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

Valor de Propriedade

MCPToolRequireApproval | "always" | "never"

server_description

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

server_description?: string

Valor de Propriedade

string

server_label

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

server_label: string

Valor de Propriedade

string

server_url

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

server_url?: string

Valor de Propriedade

string

tunnel_id

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

tunnel_id?: string

Valor de Propriedade

string

type

O tipo de ferramenta da caixa de ferramentas MCP. Sempre mcp.

type: "mcp"

Valor de Propriedade

"mcp"

Detalhes da Propriedade Herdada

description

Descrição opcional definida pelo utilizador para esta ferramenta ou configuração.

description?: string

Valor de Propriedade

string

Herdado deToolboxTool.description

name

Nome opcional definido pelo utilizador para esta ferramenta ou configuração.

name?: string

Valor de Propriedade

string

Herdado deToolboxTool.name

tool_configs

Mapa de configuração por ferramenta. As 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 em tempo de execução.

tool_configs?: Record<string, ToolConfig>

Valor de Propriedade

Record<string, ToolConfig>

Herdado deToolboxTool.tool_configs