MCPTool class

Paket:

@azure/ai-agents

Alat yang terhubung ke server Model Context Protocol (MCP). Mendukung pengelolaan koneksi server MCP dan alat yang diizinkan secara dinamis.

Konstruktor

MCPTool(string, string, string[])

Konstruktor menginisialisasi alat dengan konfigurasi server MCP.

Properti

allowedTools	Dapatkan daftar alat yang diizinkan untuk server MCP.
definition	Dapatkan definisi alat MCP.
headers	Dapatkan header untuk alat MCP.
resources	Dapatkan sumber daya alat untuk agen.
serverLabel	Dapatkan label server untuk alat MCP.
serverUrl	Dapatkan URL server untuk alat MCP.

Metode

allowTool(string)	Tambahkan alat ke daftar alat yang diizinkan.
disallowTool(string)	Hapus alat dari daftar alat yang diizinkan.
mergeResources(MCPTool[])	Gabungkan sumber daya alat dari beberapa instans MCPTool menjadi satu objek ToolResources. Ini berguna saat membuat eksekusi yang harus memiliki akses ke beberapa server MCP sekaligus.
setApprovalMode("always" | "never")	Perbarui mode persetujuan untuk alat MCP.
updateHeaders(string, string)	Perbarui header untuk alat MCP.

Detail Konstruktor

MCPTool(string, string, string[])

Konstruktor menginisialisasi alat dengan konfigurasi server MCP.

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

Parameter

serverLabel

string

Label untuk server MCP

serverUrl

string

Titik akhir untuk server MCP

allowedTools

string[]

Daftar alat yang diizinkan untuk server MCP

Detail Properti

allowedTools

Dapatkan daftar alat yang diizinkan untuk server MCP.

string[] allowedTools

Nilai Properti

string[]

definition

Dapatkan definisi alat MCP.

MCPToolDefinition definition

Nilai Properti

MCPToolDefinition

Daftar yang berisi definisi alat MCP

headers

Dapatkan header untuk alat MCP.

Record<string, string> headers

Nilai Properti

Record<string, string>

resources

Dapatkan sumber daya alat untuk agen.

ToolResources resources

Nilai Properti

ToolResources

serverLabel

Dapatkan label server untuk alat MCP.

string serverLabel

Nilai Properti

string

serverUrl

Dapatkan URL server untuk alat MCP.

string serverUrl

Nilai Properti

string

Detail Metode

allowTool(string)

Tambahkan alat ke daftar alat yang diizinkan.

function allowTool(toolName: string)

Parameter

toolName

string

Nama alat yang akan diizinkan

disallowTool(string)

Hapus alat dari daftar alat yang diizinkan.

function disallowTool(toolName: string)

Parameter

toolName

string

Nama alat yang akan dihapus dari alat yang diizinkan

mergeResources(MCPTool[])

Gabungkan sumber daya alat dari beberapa instans MCPTool menjadi satu objek ToolResources.

Ini berguna saat membuat eksekusi yang harus memiliki akses ke beberapa server MCP sekaligus.

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

Parameter

mcpTools

MCPTool[]

Array instans MCPTool yang sumber dayanya akan digabungkan.

Mengembalikan

ToolResources

Objek ToolResources yang berisi semua sumber daya alat MCP dari alat yang disediakan.

setApprovalMode("always" | "never")

Perbarui mode persetujuan untuk alat MCP.

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

Parameter

requireApproval

"always" | "never"

Pengaturan require_approval untuk memperbarui

updateHeaders(string, string)

Perbarui header untuk alat MCP.

function updateHeaders(key: string, value: string)

Parameter

key

string

Kunci header untuk memperbarui

value

string

Nilai baru untuk kunci header