McpPromptFunctionOptions interface

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

Extends

屬性

handler

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

trigger

MCP 提示字元的觸發器設定。

繼承的屬性

description

可選的提示說明。

extraInputs

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

extraOutputs

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

icons

可選的 JSON 序列化圖示物件陣列。

metadata

可選的 JSON 序列化元資料物件。

promptArguments

提示所接受的可選參數清單。

支援兩種形狀:

  • 一個包含 McpPromptArgument 物件的陣列(明確的namerequired/description/)。
  • 一個以 promptArg.describe(...) 鍵為參數名稱所建立的記錄/流變映射。
promptName

提示的唯一名稱。

return

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

title

可選為可讀的標題,方便顯示。

屬性詳細資料

handler

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

handler: McpPromptTriggerHandler<T>

屬性值

trigger

MCP 提示字元的觸發器設定。

trigger?: McpPromptTrigger

屬性值

繼承的屬性詳細資料

description

可選的提示說明。

description?: string

屬性值

string

繼承自McpPromptTriggerOptions.description

extraInputs

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

extraInputs?: FunctionInput[]

屬性值

繼承自 部分。額外輸入

extraOutputs

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

extraOutputs?: FunctionOutput[]

屬性值

繼承自 部分.額外輸出

icons

可選的 JSON 序列化圖示物件陣列。

icons?: string

屬性值

string

繼承自McpPromptTriggerOptions.圖示

metadata

可選的 JSON 序列化元資料物件。

metadata?: string

屬性值

string

繼承自McpPromptTriggerOptions.metadata

promptArguments

提示所接受的可選參數清單。

支援兩種形狀:

  • 一個包含 McpPromptArgument 物件的陣列(明確的namerequired/description/)。
  • 一個以 promptArg.describe(...) 鍵為參數名稱所建立的記錄/流變映射。
promptArguments?: McpPromptArguments

屬性值

繼承自McpPromptTriggerOptions.promptArguments

promptName

提示的唯一名稱。

promptName: string

屬性值

string

繼承自McpPromptTriggerOptions.promptName

return

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

return?: FunctionOutput

屬性值

繼承自 部分回歸

title

可選為可讀的標題,方便顯示。

title?: string

屬性值

string

繼承自McpPromptTriggerOptions.title