MCPTool class

Paquete:

@azure/ai-agents

Una herramienta que se conecta a los servidores del protocolo de contexto del modelo (MCP). Admite la gestión dinámica de las conexiones del servidor MCP y las herramientas permitidas.

Constructores

MCPTool(string, string, string[])

Constructor inicializa la herramienta con la configuración del servidor MCP.

Propiedades

allowedTools	Obtenga la lista de herramientas permitidas para el servidor MCP.
definition	Obtenga la definición de la herramienta MCP.
headers	Obtenga los encabezados de la herramienta MCP.
resources	Obtenga los recursos de la herramienta para el agente.
serverLabel	Obtenga la etiqueta del servidor para la herramienta MCP.
serverUrl	Obtenga la URL del servidor para la herramienta MCP.

Métodos

allowTool(string)	Agregue una herramienta a la lista de herramientas permitidas.
disallowTool(string)	Elimine una herramienta de la lista de herramientas permitidas.
mergeResources(MCPTool[])	Combine los recursos de herramienta de varias instancias de MCPTool en un único objeto ToolResources. Esto es útil cuando se crea una ejecución que debe tener acceso a varios servidores MCP a la vez.
setApprovalMode("always" | "never")	Actualice el modo de aprobación de la herramienta MCP.
updateHeaders(string, string)	Actualice los encabezados de la herramienta MCP.

Detalles del constructor

MCPTool(string, string, string[])

Constructor inicializa la herramienta con la configuración del servidor MCP.

new MCPTool(serverLabel: string, serverUrl: string, allowedTools?: string[])

Parámetros

serverLabel

string

La etiqueta para el servidor MCP

serverUrl

string

El punto de conexión para el servidor MCP

allowedTools

string[]

Lista de herramientas permitidas para el servidor MCP

Detalles de las propiedades

allowedTools

Obtenga la lista de herramientas permitidas para el servidor MCP.

string[] allowedTools

Valor de propiedad

string[]

definition

Obtenga la definición de la herramienta MCP.

MCPToolDefinition definition

Valor de propiedad

MCPToolDefinition

Una lista que contiene la definición de la herramienta MCP

headers

Obtenga los encabezados de la herramienta MCP.

Record<string, string> headers

Valor de propiedad

Record<string, string>

resources

Obtenga los recursos de la herramienta para el agente.

ToolResources resources

Valor de propiedad

ToolResources

serverLabel

Obtenga la etiqueta del servidor para la herramienta MCP.

string serverLabel

Valor de propiedad

string

serverUrl

Obtenga la URL del servidor para la herramienta MCP.

string serverUrl

Valor de propiedad

string

Detalles del método

allowTool(string)

Agregue una herramienta a la lista de herramientas permitidas.

function allowTool(toolName: string)

Parámetros

toolName

string

El nombre de la herramienta que se va a permitir

disallowTool(string)

Elimine una herramienta de la lista de herramientas permitidas.

function disallowTool(toolName: string)

Parámetros

toolName

string

El nombre de la herramienta que se va a quitar de las herramientas permitidas

mergeResources(MCPTool[])

Combine los recursos de herramienta de varias instancias de MCPTool en un único objeto ToolResources.

Esto es útil cuando se crea una ejecución que debe tener acceso a varios servidores MCP a la vez.

static function mergeResources(mcpTools: MCPTool[]): ToolResources

Parámetros

mcpTools

MCPTool[]

Matriz de instancias de MCPTool cuyos recursos se fusionarán.

Devoluciones

ToolResources

Un objeto ToolResources que contiene todos los recursos de la herramienta MCP de las herramientas proporcionadas.

setApprovalMode("always" | "never")

Actualice el modo de aprobación de la herramienta MCP.

function setApprovalMode(requireApproval?: "always" | "never")

Parámetros

requireApproval

"always" | "never"

La configuración require_approval que se va a actualizar

updateHeaders(string, string)

Actualice los encabezados de la herramienta MCP.

function updateHeaders(key: string, value: string)

Parámetros

key

string

La clave de encabezado para actualizar

value

string

El nuevo valor de la clave de encabezado