MCPTool class

套件:

@azure/ai-agents

連接到模型上下文協定 （MCP） 伺服器的工具。 支援動態管理 MCP 伺服器連接和允許的工具。

建構函式

MCPTool(string, string, string[])

建構函數使用 MCP 伺服器設定初始化工具。

屬性

allowedTools	獲取 MCP 伺服器允許的工具清單。
definition	獲取 MCP 工具定義。
headers	獲取 MCP 工具的標頭。
resources	獲取代理的工具資源。
serverLabel	獲取 MCP 工具的伺服器標籤。
serverUrl	獲取 MCP 工具的伺服器 URL。

方法

allowTool(string)	將工具添加到允許的工具清單中。
disallowTool(string)	從允許的工具清單中刪除工具。
mergeResources(MCPTool[])	將多個 MCPTool 實例中的工具資源合併至單一 ToolResources 物件。 這在建立應該可以同時存取多個 MCP 伺服器的執行時非常有用。
setApprovalMode("always" | "never")	更新 MCP 工具的審批模式。
updateHeaders(string, string)	更新 MCP 工具的標頭。

建構函式詳細資料

MCPTool(string, string, string[])

建構函數使用 MCP 伺服器設定初始化工具。

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

參數

serverLabel

string

MCP 伺服器的標籤

serverUrl

string

MCP 伺服器的端點

allowedTools

string[]

MCP 伺服器允許的工具清單

屬性詳細資料

allowedTools

獲取 MCP 伺服器允許的工具清單。

string[] allowedTools

屬性值

string[]

definition

獲取 MCP 工具定義。

MCPToolDefinition definition

屬性值

MCPToolDefinition

包含 MCP 刀具定義的清單

headers

獲取 MCP 工具的標頭。

Record<string, string> headers

屬性值

Record<string, string>

resources

獲取代理的工具資源。

ToolResources resources

屬性值

ToolResources

serverLabel

獲取 MCP 工具的伺服器標籤。

string serverLabel

屬性值

string

serverUrl

獲取 MCP 工具的伺服器 URL。

string serverUrl

屬性值

string

方法詳細資料

allowTool(string)

將工具添加到允許的工具清單中。

function allowTool(toolName: string)

參數

toolName

string

允許的工具名稱

disallowTool(string)

從允許的工具清單中刪除工具。

function disallowTool(toolName: string)

參數

toolName

string

要從允許的工具中刪除的工具的名稱

mergeResources(MCPTool[])

將多個 MCPTool 實例中的工具資源合併至單一 ToolResources 物件。

這在建立應該可以同時存取多個 MCP 伺服器的執行時非常有用。

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

參數

mcpTools

MCPTool[]

將合併其資源的 MCPTool 實例陣列。

傳回

ToolResources

ToolResources 物件，其中包含所提供工具的所有 MCP 工具資源。

setApprovalMode("always" | "never")

更新 MCP 工具的審批模式。

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

參數

requireApproval

"always" | "never"

要更新的require_approval設置

updateHeaders(string, string)

更新 MCP 工具的標頭。

function updateHeaders(key: string, value: string)

參數

key

string

要更新的標頭鍵

value

string

標頭鍵的新值