MCPTool class

Paket:

@azure/ai-agents

Ein Werkzeug, das eine Verbindung mit MCP-Servern (Model Context Protocol) herstellt. Unterstützt die dynamische Verwaltung von MCP-Serververbindungen und zugelassenen Tools.

Konstruktoren

MCPTool(string, string, string[])

Der Konstruktor initialisiert das Werkzeug mit der MCP-Serverkonfiguration.

Eigenschaften

allowedTools	Rufen Sie die Liste der zulässigen Tools für den MCP-Server ab.
definition	Rufen Sie die MCP-Werkzeugdefinition ab.
headers	Rufen Sie die Header für das MCP-Tool ab.
resources	Rufen Sie die Werkzeugressourcen für den Agent ab.
serverLabel	Rufen Sie die Serverbezeichnung für das MCP-Tool ab.
serverUrl	Rufen Sie die Server-URL für das MCP-Tool ab.

Methoden

allowTool(string)	Fügen Sie der Liste der zulässigen Werkzeuge ein Werkzeug hinzu.
disallowTool(string)	Entfernen Sie ein Werkzeug aus der Liste der zulässigen Werkzeuge.
mergeResources(MCPTool[])	Führen Sie die Werkzeugressourcen aus mehreren MCPTool-Instanzen in einem einzigen ToolResources-Objekt zusammen. Dies ist nützlich, wenn Sie eine Ausführung erstellen, die Zugriff auf mehrere MCP-Server gleichzeitig haben soll.
setApprovalMode("always" | "never")	Aktualisieren Sie den Genehmigungsmodus für das MCP-Tool.
updateHeaders(string, string)	Aktualisieren Sie die Kopfzeilen für das MCP-Tool.

Details zum Konstruktor

MCPTool(string, string, string[])

Der Konstruktor initialisiert das Werkzeug mit der MCP-Serverkonfiguration.

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

Parameter

serverLabel

string

Die Bezeichnung für den MCP-Server

serverUrl

string

Der Endpunkt für den MCP-Server

allowedTools

string[]

Liste der erlaubten Tools für den MCP-Server

Details zur Eigenschaft

allowedTools

Rufen Sie die Liste der zulässigen Tools für den MCP-Server ab.

string[] allowedTools

Eigenschaftswert

string[]

definition

Rufen Sie die MCP-Werkzeugdefinition ab.

MCPToolDefinition definition

Eigenschaftswert

MCPToolDefinition

Eine Liste mit der MCP-Werkzeugdefinition

headers

Rufen Sie die Header für das MCP-Tool ab.

Record<string, string> headers

Eigenschaftswert

Record<string, string>

resources

Rufen Sie die Werkzeugressourcen für den Agent ab.

ToolResources resources

Eigenschaftswert

ToolResources

serverLabel

Rufen Sie die Serverbezeichnung für das MCP-Tool ab.

string serverLabel

Eigenschaftswert

string

serverUrl

Rufen Sie die Server-URL für das MCP-Tool ab.

string serverUrl

Eigenschaftswert

string

Details zur Methode

allowTool(string)

Fügen Sie der Liste der zulässigen Werkzeuge ein Werkzeug hinzu.

function allowTool(toolName: string)

Parameter

toolName

string

Der Name des Werkzeugs, das zugelassen werden soll

disallowTool(string)

Entfernen Sie ein Werkzeug aus der Liste der zulässigen Werkzeuge.

function disallowTool(toolName: string)

Parameter

toolName

string

Der Name des Werkzeugs, das aus den zulässigen Werkzeugen entfernt werden soll

mergeResources(MCPTool[])

Führen Sie die Werkzeugressourcen aus mehreren MCPTool-Instanzen in einem einzigen ToolResources-Objekt zusammen.

Dies ist nützlich, wenn Sie eine Ausführung erstellen, die Zugriff auf mehrere MCP-Server gleichzeitig haben soll.

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

Parameter

mcpTools

MCPTool[]

Ein Array von MCPTool-Instanzen, deren Ressourcen zusammengeführt werden.

Gibt zurück

ToolResources

Ein ToolResources-Objekt, das alle MCP-Werkzeugressourcen aus den bereitgestellten Tools enthält.

setApprovalMode("always" | "never")

Aktualisieren Sie den Genehmigungsmodus für das MCP-Tool.

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

Parameter

requireApproval

"always" | "never"

Die require_approval Einstellung, die aktualisiert werden soll

updateHeaders(string, string)

Aktualisieren Sie die Kopfzeilen für das MCP-Tool.

function updateHeaders(key: string, value: string)

Parameter

key

string

Der zu aktualisierende Header-Schlüssel

value

string

Der neue Wert für den Header-Schlüssel