MCPTool interface

Paquete:

@azure/ai-projects

Asigne al modelo acceso a herramientas adicionales a través de servidores remotos del Protocolo de Contexto de Modelo (MCP). Más información sobre MCP.

Extends

Tool

Propiedades

allowed_callers	Los llamantes que puedan invocar esta herramienta.
allowed_tools	La lista de nombres permitidos para las herramientas del servidor MCP.
authorization	Un token de acceso OAuth que puede usarse con un servidor MCP remoto, ya sea con una URL personalizada de servidor MCP o un conector de servicio. Tu aplicación debe gestionar el flujo de autorización OAuth y proporcionar el token aquí.
connector_id	Identificador para conectores de servicio, como los disponibles en ChatGPT. Uno de server_url, connector_id, o tunnel_id debe ser proporcionado. Descubre más sobre los conectores de servicio aquí. Los valores actualmente soportados connector_id son: Dropbox: connector_dropbox Gmail: connector_gmail Google Calendar: connector_googlecalendar Google Drive: connector_googledrive Microsoft Teams:connector_microsoftteams Outlook Calendario: connector_outlookcalendar Outlook Correo electrónico: connector_outlookemail SharePoint:connector_sharepoint
defer_loading	Si esta herramienta MCP se aplaza y se descubre mediante búsqueda de herramientas.
headers	Cabeceras personalizadas para incluir en las peticiones al servidor MCP.
project_connection_id	Identificador de conexión del project para el servidor MCP. La conexión almacena la autenticación y otros detalles de conexión necesarios para conectarse al servidor MCP.
require_approval	Los requisitos de aprobación para la herramienta MCP.
server_description	Descripción opcional del servidor MCP, usada para proporcionar más contexto.
server_label	Etiqueta para este servidor MCP, que se usa para identificarlo en las llamadas a herramientas.
server_url	Dirección URL del servidor MCP. Uno de server_url, connector_id, o tunnel_id debe ser proporcionado.
tool_configs	Deprecated. Esta propiedad queda obsoleta y será eliminada en una versión futura.
tunnel_id	El ID del túnel MCP seguro para usar en lugar de una URL directa del servidor. Uno de server_url, connector_id, o tunnel_id debe ser proporcionado.
type	Tipo de la herramienta MCP. Siempre mcp.

Detalles de las propiedades

allowed_callers

Los llamantes que puedan invocar esta herramienta.

allowed_callers?: CallableToolAllowedCaller[]

Valor de propiedad

CallableToolAllowedCaller[]

allowed_tools

La lista de nombres permitidos para las herramientas del servidor MCP.

allowed_tools?: string[] | MCPToolFilter

Valor de propiedad

string[] | MCPToolFilter

authorization

Un token de acceso OAuth que puede usarse con un servidor MCP remoto, ya sea con una URL personalizada de servidor MCP o un conector de servicio. Tu aplicación debe gestionar el flujo de autorización OAuth y proporcionar el token aquí.

authorization?: string

Valor de propiedad

string

connector_id

Identificador para conectores de servicio, como los disponibles en ChatGPT. Uno de server_url, connector_id, o tunnel_id debe ser proporcionado. Descubre más sobre los conectores de servicio aquí. Los valores actualmente soportados connector_id son:

• Dropbox: connector_dropbox
• Gmail: connector_gmail
• Google Calendar: connector_googlecalendar
• Google Drive: connector_googledrive
• Microsoft Teams:connector_microsoftteams
• Outlook Calendario: connector_outlookcalendar
• Outlook Correo electrónico: 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 propiedad

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

defer_loading

Si esta herramienta MCP se aplaza y se descubre mediante búsqueda de herramientas.

defer_loading?: boolean

Valor de propiedad

boolean

headers

Cabeceras personalizadas para incluir en las peticiones al servidor MCP.

headers?: Record<string, string>

Valor de propiedad

Record<string, string>

project_connection_id

Identificador de conexión del project para el servidor MCP. La conexión almacena la autenticación y otros detalles de conexión necesarios para conectarse al servidor MCP.

project_connection_id?: string

Valor de propiedad

string

require_approval

Los requisitos de aprobación para la herramienta MCP.

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

Valor de propiedad

MCPToolRequireApproval | "always" | "never"

server_description

Descripción opcional del servidor MCP, usada para proporcionar más contexto.

server_description?: string

Valor de propiedad

string

server_label

Etiqueta para este servidor MCP, que se usa para identificarlo en las llamadas a herramientas.

server_label: string

Valor de propiedad

string

server_url

Dirección URL del servidor MCP. Uno de server_url, connector_id, o tunnel_id debe ser proporcionado.

server_url?: string

Valor de propiedad

string

tool_configs

Deprecated. Esta propiedad queda obsoleta y será eliminada en una versión futura.

tool_configs?: Record<string, ToolConfig>

Valor de propiedad

Record<string, ToolConfig>

tunnel_id

El ID del túnel MCP seguro para usar en lugar de una URL directa del servidor. Uno de server_url, connector_id, o tunnel_id debe ser proporcionado.

tunnel_id?: string

Valor de propiedad

string

type

Tipo de la herramienta MCP. Siempre mcp.

type: "mcp"

Valor de propiedad

"mcp"