@azure/functions package
類別
| AppStartContext |
應用程式啟動時函式應用程式的上下文。 |
| AppTerminateContext |
應用程式終止時函式應用程式的上下文。 |
| Disposable |
代表一種可釋放資源的類型,例如事件監聽或計時器。 |
| HookContext |
所有掛鉤上下文物件的基底類別 |
| HttpRequest |
HTTP 要求物件。 使用 HTTP 系結時提供給您的函式。 |
| HttpResponse |
HTTP 回應類別 |
| InvocationContext |
包含此調用專屬的元數據和協助程式方法 |
| InvocationHookContext |
所有呼叫鉤子上下文物件的基底類別 |
| LogHookContext |
記錄中的上下文 |
| McpAudioContent |
MCP 工具回應中的音訊內容區塊。 |
| McpContentBlock |
MCP 工具回應內容區塊的抽象基底類別。 Azure Functions 函式庫會使用 像 以自訂內容區塊類型進行擴充如果 MCP 規範新增了新的區塊類型——或你的情境需要自訂的——你可以在不更改任何函式庫的情況下推出自己的子類別。 轉換器只會檢查 範例:新增一個假設性情形
|
| McpImageContent |
MCP 工具回應中的圖片內容區塊。 |
| McpPromptArgumentBuilder |
流暢建構器,可在記錄形狀 預設情況下,參數為 可選;呼叫 範例
|
| McpResourceContent |
MCP 工具回應中的嵌入資源內容區塊。 |
| McpResourceLinkContent |
MCP 工具回應中的資源連結內容區塊。 |
| McpTextContent |
MCP 工具回應中的文字內容區塊。 |
| McpToolResponse |
完整的 MCP 工具回應,包含明確的內容區塊與可選的結構化內容。
當你需要同時控制內容陣列與
|
| PostInvocationContext |
函式執行後的上下文。 |
| PreInvocationContext |
函式執行前的上下文。 |
| PromptInvocationContext |
傳遞給 MCP 提示程式處理器的結構化上下文物件。 提供對被喚出提示字元名稱、參數(所有值皆為字串)、可選的工作階段 ID 及可選傳輸元資料的類型存取。 範例
|
介面
類型別名
列舉
| CosmosDBv4ChangeFeedMode |
變更 Cosmos DB 觸發鍵綁定的饋送模式。 |
| MySqlChangeOperation | |
| SqlChangeOperation | |
函式
| Mcp |
將類別或建構函式標記為 MCP 結果型態,該類型應序列化為結構化內容。 當函式回傳以此標記裝飾的型別實例時,結果將同時序列化為文字內容(以符合向下相容性)及結構化內容(支援此格式的用戶端)。 若不使用標記,純物件會序列化為純文字(JSON 字串化)。
如果您需要在沒有類別的情況下明確控制 structuredContent,請使用此
程式化使用 (無需
裝飾器使用 (需
支援的表單:
請參閱 McpToolResponse相關內容區塊 + 結構化內容 請參閱 McpTextContent關於回傳單一內容區塊 |
| Mcp |
變數
| arg | 工廠函數用於建立新的工具屬性建構器 範例
|
| prompt |
用於建立 MCP 提示 參數建構器的工廠。 由於提示參數未設定型別(僅 |
函式詳細資料
McpContent<T>(T)
將類別或建構函式標記為 MCP 結果型態,該類型應序列化為結構化內容。
當函式回傳以此標記裝飾的型別實例時,結果將同時序列化為文字內容(以符合向下相容性)及結構化內容(支援此格式的用戶端)。
若不使用標記,純物件會序列化為純文字(JSON 字串化)。
如果您需要在沒有類別的情況下明確控制 structuredContent,請使用此 McpToolResponse 方法。
程式化使用 (無需 experimentalDecorators使用):
class ImageMetadata {
constructor(public imageId: string, public format: string) {}
}
McpContent(ImageMetadata); // marks the class
app.mcpTool('GetImage', {
toolName: 'GetImage',
description: 'Returns image info',
handler: async () => new ImageMetadata('logo', 'png')
});
裝飾器使用 (需 experimentalDecorators: true 在 tsconfig 中說明):
@McpContent
class ImageMetadata { ... }
支援的表單:
@McpContent@McpContent()McpContent(MyClass)
請參閱 McpToolResponse相關內容區塊 + 結構化內容 請參閱 McpTextContent關於回傳單一內容區塊
function McpContent<T>(target: T): T
參數
- target
-
T
可選的類別或建構函數,用於標記結構化內容。
傳回
T
目標類別/函式不變,或是類別裝飾器。
McpContent()
function McpContent(): (target: T) => T
傳回
(target: T) => T
變數詳細資料
arg
工廠函數用於建立新的工具屬性建構器
範例
const toolProperties = {
snippetName: arg
.string()
.describe("Some Description"),
optionalField: arg
.number()
.describe("Optional number field")
.optional(),
};
arg: { boolean() => IToolPropertyBuilder, datetime() => IToolPropertyBuilder, double() => IToolPropertyBuilder, integer() => IToolPropertyBuilder, long() => IToolPropertyBuilder, number() => IToolPropertyBuilder, object() => IToolPropertyBuilder, string() => IToolPropertyBuilder }
類型
{ boolean() => IToolPropertyBuilder, datetime() => IToolPropertyBuilder, double() => IToolPropertyBuilder, integer() => IToolPropertyBuilder, long() => IToolPropertyBuilder, number() => IToolPropertyBuilder, object() => IToolPropertyBuilder, string() => IToolPropertyBuilder }
promptArg
用於建立 MCP 提示 參數建構器的工廠。
由於提示參數未設定型別(僅name有 、 可選 description及一個required旗標),因此與工具屬性arg助手分開使用。
promptArg: { describe(description: string) => McpPromptArgumentBuilder }
類型
{ describe(description: string) => McpPromptArgumentBuilder }