MCPTool interface

Pacote:
@azure/ai-projects

Dê ao modelo acesso a ferramentas adicionais por meio de servidores MCP (Model Context Protocol) remotos. Saiba mais sobre MCP.

Extends
Tool

Propriedades

allowed_tools

A lista de nomes de ferramentas permitidos para o servidor MCP.
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 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

Os requisitos de aprovação para a ferramenta MCP.
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.
tool_configs

Deprecated. Esta propriedade está obsoleta e será removida numa versão futura.
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 da ferramenta MCP. Sempre mcp.

Detalhes de Propriedade

allowed_tools

A lista de nomes de ferramentas permitidos para o servidor MCP.

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 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

Os requisitos de aprovação para a ferramenta MCP.

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

tool_configs

Deprecated. Esta propriedade está obsoleta e será removida numa versão futura.

tool_configs?: Record<string, ToolConfig>

Valor de Propriedade

Record<string, ToolConfig>

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 da ferramenta MCP. Sempre mcp.

type: "mcp"

Valor de Propriedade

"mcp"