MCPTool class

Pacote:

@azure/ai-agents

Uma ferramenta que se conecta a servidores MCP (Model Context Protocol). Suporta o gerenciamento de conexões de servidor MCP e ferramentas permitidas dinamicamente.

Construtores

MCPTool(string, string, string[])

O construtor inicializa a ferramenta com a configuração do servidor MCP.

Propriedades

allowedTools	Obtenha a lista de ferramentas permitidas para o servidor MCP.
definition	Obtenha a definição da ferramenta MCP.
headers	Obtenha os cabeçalhos para a ferramenta MCP.
resources	Obtenha os recursos da ferramenta para o agente.
serverLabel	Obtenha o rótulo do servidor para a ferramenta MCP.
serverUrl	Obtenha a URL do servidor para a ferramenta MCP.

Métodos

allowTool(string)	Adicione uma ferramenta à lista de ferramentas permitidas.
disallowTool(string)	Remova uma ferramenta da lista de ferramentas permitidas.
mergeResources(MCPTool[])	Mescle os recursos da ferramenta de várias instâncias MCPTool em um único objeto ToolResources. Isso é útil ao criar uma execução que deve ter acesso a vários servidores MCP ao mesmo tempo.
setApprovalMode("always" | "never")	Atualize o modo de aprovação para a ferramenta MCP.
updateHeaders(string, string)	Atualize os cabeçalhos para a ferramenta MCP.

Detalhes do Construtor

MCPTool(string, string, string[])

O construtor inicializa a ferramenta com a configuração do servidor MCP.

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

Parâmetros

serverLabel

string

O rótulo para o servidor MCP

serverUrl

string

O ponto de extremidade para o servidor MCP

allowedTools

string[]

Lista de ferramentas permitidas para o servidor MCP

Detalhes de Propriedade

allowedTools

Obtenha a lista de ferramentas permitidas para o servidor MCP.

string[] allowedTools

Valor de Propriedade

string[]

definition

Obtenha a definição da ferramenta MCP.

MCPToolDefinition definition

Valor de Propriedade

MCPToolDefinition

Uma lista contendo a definição da ferramenta MCP

headers

Obtenha os cabeçalhos para a ferramenta MCP.

Record<string, string> headers

Valor de Propriedade

Record<string, string>

resources

Obtenha os recursos da ferramenta para o agente.

ToolResources resources

Valor de Propriedade

ToolResources

serverLabel

Obtenha o rótulo do servidor para a ferramenta MCP.

string serverLabel

Valor de Propriedade

string

serverUrl

Obtenha a URL do servidor para a ferramenta MCP.

string serverUrl

Valor de Propriedade

string

Detalhes de Método

allowTool(string)

Adicione uma ferramenta à lista de ferramentas permitidas.

function allowTool(toolName: string)

Parâmetros

toolName

string

O nome da ferramenta para permitir

disallowTool(string)

Remova uma ferramenta da lista de ferramentas permitidas.

function disallowTool(toolName: string)

Parâmetros

toolName

string

O nome da ferramenta a ser removida das ferramentas permitidas

mergeResources(MCPTool[])

Mescle os recursos da ferramenta de várias instâncias MCPTool em um único objeto ToolResources.

Isso é útil ao criar uma execução que deve ter acesso a vários servidores MCP ao mesmo tempo.

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

Parâmetros

mcpTools

MCPTool[]

Uma matriz de instâncias MCPTool cujos recursos serão mesclados.

Devoluções

ToolResources

Um objeto ToolResources contendo todos os recursos da ferramenta MCP das ferramentas fornecidas.

setApprovalMode("always" | "never")

Atualize o modo de aprovação para a ferramenta MCP.

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

Parâmetros

requireApproval

"always" | "never"

A configuração de require_approval a ser atualizada

updateHeaders(string, string)

Atualize os cabeçalhos para a ferramenta MCP.

function updateHeaders(key: string, value: string)

Parâmetros

key

string

A chave de cabeçalho a ser atualizada

value

string

O novo valor para a chave de cabeçalho