McpToolFunctionOptions interface

MCP 工具函數的設定選項。 這包括觸發器專屬選項以及一般功能選項。

Extends

屬性

handler

觸發器被呼叫時執行的處理函數。

trigger

MCP 工具的觸發器設定。

繼承的屬性

description

工具或觸發器的描述。 這提供了關於觸發器目的的額外背景。

extraInputs

在叫用期間,針對一組選擇性的次要輸入進行組態,以 context.extraInputs.get() 取得這些值

extraOutputs

設定選擇性的次要輸出集合在調用期間,請使用 context.extraOutputs.set()

metadata

JSON 序列化的元資料物件。 關於該工具的額外 JSON 格式元資料。

resultSchema

可選的 JSON 序列化 JSON 架構,描述此工具的結構化結果。

當提供時,該值會以 JSON 形式驗證並一併 useResultSchema: true 傳送,讓支援結構化內容的 MCP 用戶端可以使用已宣告的架構。

return

函式選擇性主要輸出的組態 這是您應該在調用期間設定為函式處理程式的傳回值的主要輸出

toolName

與觸發器相關聯的工具名稱。 這通常是應用程式設定或環境變數。

toolProperties

工具的額外屬性或元資料。 可提供陣列或 Args 物件格式。

屬性詳細資料

handler

觸發器被呼叫時執行的處理函數。

handler: McpToolTriggerHandler<T>

屬性值

trigger

MCP 工具的觸發器設定。

trigger?: McpToolTrigger

屬性值

繼承的屬性詳細資料

description

工具或觸發器的描述。 這提供了關於觸發器目的的額外背景。

description: string

屬性值

string

繼承自McpToolTriggerOptions.description

extraInputs

在叫用期間,針對一組選擇性的次要輸入進行組態,以 context.extraInputs.get() 取得這些值

extraInputs?: FunctionInput[]

屬性值

繼承自 部分。額外輸入

extraOutputs

設定選擇性的次要輸出集合在調用期間,請使用 context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

屬性值

繼承自 部分.額外輸出

metadata

JSON 序列化的元資料物件。 關於該工具的額外 JSON 格式元資料。

metadata?: string

屬性值

string

繼承自McpToolTriggerOptions.metadata

resultSchema

可選的 JSON 序列化 JSON 架構,描述此工具的結構化結果。

當提供時,該值會以 JSON 形式驗證並一併 useResultSchema: true 傳送,讓支援結構化內容的 MCP 用戶端可以使用已宣告的架構。

resultSchema?: string

屬性值

string

繼承自McpToolTriggerOptions.resultSchema

return

函式選擇性主要輸出的組態 這是您應該在調用期間設定為函式處理程式的傳回值的主要輸出

return?: FunctionOutput

屬性值

繼承自 部分回歸

toolName

與觸發器相關聯的工具名稱。 這通常是應用程式設定或環境變數。

toolName: string

屬性值

string

繼承自McpToolTriggerOptions.toolName

toolProperties

工具的額外屬性或元資料。 可提供陣列或 Args 物件格式。

toolProperties?: McpToolProperty[] | Args

屬性值

繼承自McpToolTriggerOptions.toolProperties