MCPTool class

Paket:

@azure/ai-agents

Ett verktyg som ansluter till MCP-servrar (Model Context Protocol). Stöd för hantering av MCP-serveranslutningar och tillåtna verktyg dynamiskt.

Konstruktorer

MCPTool(string, string, string[])

Konstruktorn initierar verktyget med MCP-serverkonfiguration.

Egenskaper

allowedTools	Hämta listan över tillåtna verktyg för MCP-servern.
definition	Hämta definitionen av MCP-verktyget.
headers	Hämta rubrikerna för MCP-verktyget.
resources	Hämta verktygsresurserna för handläggaren.
serverLabel	Hämta serveretiketten för MCP-verktyget.
serverUrl	Hämta server-URL:en för MCP-verktyget.

Metoder

allowTool(string)	Lägg till ett verktyg i listan över tillåtna verktyg.
disallowTool(string)	Ta bort ett verktyg från listan över tillåtna verktyg.
mergeResources(MCPTool[])	Sammanfoga verktygsresurserna från flera MCPTool-instanser till ett enda ToolResources-objekt. Detta är användbart när du skapar en körning som ska ha åtkomst till flera MCP-servrar samtidigt.
setApprovalMode("always" | "never")	Uppdatera godkännandeläget för MCP-verktyget.
updateHeaders(string, string)	Uppdatera rubrikerna för MCP-verktyget.

Konstruktorinformation

MCPTool(string, string, string[])

Konstruktorn initierar verktyget med MCP-serverkonfiguration.

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

Parametrar

serverLabel

string

Etiketten för MCP-servern

serverUrl

string

Slutpunkten för MCP-servern

allowedTools

string[]

Lista över tillåtna verktyg för MCP-server

Egenskapsinformation

allowedTools

Hämta listan över tillåtna verktyg för MCP-servern.

string[] allowedTools

Egenskapsvärde

string[]

definition

Hämta definitionen av MCP-verktyget.

MCPToolDefinition definition

Egenskapsvärde

MCPToolDefinition

En lista som innehåller definitionen av MCP-verktyget

headers

Hämta rubrikerna för MCP-verktyget.

Record<string, string> headers

Egenskapsvärde

Record<string, string>

resources

Hämta verktygsresurserna för handläggaren.

ToolResources resources

Egenskapsvärde

ToolResources

serverLabel

Hämta serveretiketten för MCP-verktyget.

string serverLabel

Egenskapsvärde

string

serverUrl

Hämta server-URL:en för MCP-verktyget.

string serverUrl

Egenskapsvärde

string

Metodinformation

allowTool(string)

Lägg till ett verktyg i listan över tillåtna verktyg.

function allowTool(toolName: string)

Parametrar

toolName

string

Namnet på verktyget som ska tillåtas

disallowTool(string)

Ta bort ett verktyg från listan över tillåtna verktyg.

function disallowTool(toolName: string)

Parametrar

toolName

string

Namnet på verktyget som ska tas bort från tillåtna verktyg

mergeResources(MCPTool[])

Sammanfoga verktygsresurserna från flera MCPTool-instanser till ett enda ToolResources-objekt.

Detta är användbart när du skapar en körning som ska ha åtkomst till flera MCP-servrar samtidigt.

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

Parametrar

mcpTools

MCPTool[]

En matris med MCPTool-instanser vars resurser kommer att slås samman.

Returer

ToolResources

Ett ToolResources-objekt som innehåller alla MCP-verktygsresurser från de angivna verktygen.

setApprovalMode("always" | "never")

Uppdatera godkännandeläget för MCP-verktyget.

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

Parametrar

requireApproval

"always" | "never"

Den require_approval inställningen som ska uppdateras

updateHeaders(string, string)

Uppdatera rubrikerna för MCP-verktyget.

function updateHeaders(key: string, value: string)

Parametrar

key

string

Rubriknyckeln som ska uppdateras

value

string

Det nya värdet för rubriknyckeln