McpResourceFunctionOptions interface

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

Extends

屬性

handler

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

trigger

MCP 資源的觸發設定。

繼承的屬性

description

資源的描述。 提供關於該資源代表什麼的額外背景資訊。

extraInputs

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

extraOutputs

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

metadata

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

mimeType

資源內容的 MIME 類型。 指定資源資料的格式(例如:'application/json'、'text/plain')。

resourceName

資源的可讀名稱。 此名稱會在 MCP 用戶端介面中顯示給使用者。

return

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

size

可選的大小(以位元組為單位)。 資源內容的預期大小(如已知)。

title

為展示目的的可選標題。 一個更具描述性的標題,可以在 UI 元素中顯示。

uri

資源的唯一 URI 識別碼(必須為絕對)。 這是 MCP 用戶端用來參考該資源的標準識別碼。

屬性詳細資料

handler

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

handler: McpResourceTriggerHandler<T>

屬性值

trigger

MCP 資源的觸發設定。

trigger?: McpResourceTrigger

屬性值

繼承的屬性詳細資料

description

資源的描述。 提供關於該資源代表什麼的額外背景資訊。

description?: string

屬性值

string

繼承自McpResourceTriggerOptions.description

extraInputs

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

extraInputs?: FunctionInput[]

屬性值

繼承自 部分。額外輸入

extraOutputs

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

extraOutputs?: FunctionOutput[]

屬性值

繼承自 部分.額外輸出

metadata

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

metadata?: string

屬性值

string

繼承自McpResourceTriggerOptions.metadata

mimeType

資源內容的 MIME 類型。 指定資源資料的格式(例如:'application/json'、'text/plain')。

mimeType?: string

屬性值

string

繼承自McpResourceTriggerOptions.mimeType

resourceName

資源的可讀名稱。 此名稱會在 MCP 用戶端介面中顯示給使用者。

resourceName: string

屬性值

string

繼承自McpResourceTriggerOptions.resourceName

return

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

return?: FunctionOutput

屬性值

繼承自 部分回歸

size

可選的大小(以位元組為單位)。 資源內容的預期大小(如已知)。

size?: number

屬性值

number

繼承自McpResourceTriggerOptions.size

title

為展示目的的可選標題。 一個更具描述性的標題,可以在 UI 元素中顯示。

title?: string

屬性值

string

繼承自McpResourceTriggerOptions.title

uri

資源的唯一 URI 識別碼(必須為絕對)。 這是 MCP 用戶端用來參考該資源的標準識別碼。

uri: string

屬性值

string

繼承自McpResourceTriggerOptions.uri