你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

@azure/functions package

类

AppStartContext

应用启动时函数应用的上下文。

AppTerminateContext

应用终止期间函数应用的上下文。

Disposable

表示一种类型,可以释放资源,例如事件监听或定时器。

HookContext

所有钩子上下文对象的基类

HttpRequest

HTTP 请求对象。 使用 HTTP 绑定时提供给函数。

HttpResponse

HTTP 响应类

InvocationContext

包含特定于此调用的元数据和帮助程序方法

InvocationHookContext

所有调用钩子上下文对象的基类

LogHookContext

日志上的上下文

McpAudioContent

MCP 工具响应中的音频内容块。

McpContentBlock

MCP 工具响应内容块的抽象基类。

Azure Functions 库使用 instanceof McpContentBlock,将内容块与纯用户值区分开来,因此只有内置子类(McpTextContent、McpResourceLinkContentMcpImageContentMcpAudioContentMcpResourceContent)的实例——或扩展该类的自定义子类——才会被视为内容块。

像这样的 { type: 'text', text: '...' } 纯对象文字 不会 被当作内容块处理,而是会被序列化为 JSON 文本。

通过自定义内容块类型进行扩展

如果 MCP 规范新增了块类型——或者你的场景需要自定义的块类型——你就可以在不更改任何库的情况下发布自己的子类。 转换器只检查 instanceof McpContentBlock 并调用 JSON.stringify(block),从而调用 来 toJSON() 生成线材载荷。

示例:添加假设性情形 VideoContent

import { McpContentBlock } from '@azure/functions';

export interface VideoContentInit {
    data: string | Buffer | ArrayBuffer;
    mimeType: string;          // e.g. 'video/mp4'
    durationMs?: number;       // optional field from a hypothetical spec
}

export class VideoContent extends McpContentBlock {
    readonly type = 'video' as const;
    readonly data: string | Buffer | ArrayBuffer;
    readonly mimeType: string;
    readonly durationMs?: number;

    constructor(init: VideoContentInit) {
        super();
        this.data = init.data;
        this.mimeType = init.mimeType;
        this.durationMs = init.durationMs;
    }

    toJSON(): Record<string, unknown> {
        const out: Record<string, unknown> = {
            type: this.type,
            data: toBase64(this.data),
            mimeType: this.mimeType,
        };
        if (this.durationMs !== undefined) out.durationMs = this.durationMs;
        return out;
    }
}

function toBase64(data: string | Buffer | ArrayBuffer): string {
    if (typeof data === 'string') return data;
    if (Buffer.isBuffer(data)) return data.toString('base64');
    return Buffer.from(new Uint8Array(data)).toString('base64');
}

使用工具处理程序中的自定义模块

// Single block
handler: async () => new VideoContent({ data: buf, mimeType: 'video/mp4' })

// Mixed with built-ins + structured content
handler: async () => new McpToolResponse({
    content: [
        new McpTextContent('Detected 3 scenes'),
        new VideoContent({ data: buf, mimeType: 'video/mp4' }),
    ],
    structuredContent: { scenes: 3, confidence: 0.92 },
})

图书馆为你做什么

  • instanceof McpContentBlock 将你的子职业视为与内置方块相同的方式。
  • 单块返回将字符串 type 传播到外部结果;数组被包裹为 multi_content_result。
  • structuredContent 处理、回退文本合成和 nullish 直通均保持不变。

你在子职业中必须做到的部分

  • toJSON() 必须返回规格要求 type的完全相同线形。
  • 二进制载荷应以base64编码(toJSON()见上文辅助工具)。toBase64
  • 纯对象文字 无法 识别——您必须构造一个实例。
McpImageContent

MCP 工具响应中的图像内容块。

McpPromptArgumentBuilder

用于在记录形状 promptArguments 地图中声明 MCP 提示参数的流畅构建器。 映射键提供参数名称。

默认情况下,参数为 可选;调用 .isRequired() 以标记为必需。

示例

promptArguments: {
    function_name: promptArg.describe('The function to document.').isRequired(),
    style: promptArg.describe("Documentation style (e.g., 'concise', 'verbose')."),
}
McpResourceContent

MCP 工具响应中的嵌入资源内容块。

McpResourceLinkContent

MCP 工具响应中的资源链接内容块。

McpTextContent

MCP 工具响应中的文本内容块。

McpToolResponse

完整的 MCP 工具响应,包含明确的内容块和可选的结构化内容。 当你需要对内容数组和 structuredContent都进行完全控制时,从工具处理器返回该类的实例。

return new McpToolResponse({
  content: [
    new McpTextContent('Here is the image'),
    new McpImageContent({ data: base64Data, mimeType: 'image/png' })
  ],
  structuredContent: { imageId: 'logo', format: 'png' }
});
PostInvocationContext

函数执行后对上下文的描述。

PreInvocationContext

函数执行前的上下文。

PromptInvocationContext

传递给 MCP 提示符处理程序的结构化上下文对象。

提供对调用提示符名称、参数(所有值均为字符串)、可选会话 ID 和可选传输元数据的类型访问。

示例

app.mcpPrompt('codeReview', {
    promptName: 'code_review',
    promptArguments: [
        { name: 'code', description: 'The code to review', required: true },
        { name: 'language', description: 'Programming language' }
    ],
    handler: async (ctx: PromptInvocationContext) => {
        const code = ctx.arguments.code ?? '';
        const language = ctx.arguments.language ?? 'typescript';
        return `Review this ${language} code:\n${code}`;
    }
});

接口

AppStartContextInit

传给 AppStartContext 构造函数的对象。 仅用于测试目的

AppTerminateContextInit

对象传递给 AppTerminateContext 构造函数。 仅用于测试目的

ConnectorTriggerFunctionOptions
ConnectorTriggerOptions
Cookie

Http 响应 Cookie 对象为“Set-Cookie”

CosmosDBv3FunctionOptions
CosmosDBv3InputOptions
CosmosDBv3OutputOptions
CosmosDBv3TriggerOptions
CosmosDBv4AllVersionsAndDeletesFunctionOptions
CosmosDBv4ChangeFeedItem

当 为 AllVersionsAndDeletes时,changeFeedMode发出的全保真变更馈源项目有效载荷。 属性名称遵循 Cosmos DB 发出的线格式。

CosmosDBv4ChangeFeedMetadata

在使用 AllVersionsAndDeletes. 时,每个变更馈送项都包含元数据。 属性名称遵循 Cosmos DB 发出的线格式。

CosmosDBv4InputOptions
CosmosDBv4LatestVersionFunctionOptions
CosmosDBv4OutputOptions
CosmosDBv4TriggerOptions
Duration
EffectiveFunctionOptions

注册函数时使用的选项,如传递给特定调用说明:此值可能与原始值略有不同,因为它已经过验证,默认值可能已显式添加

EventGridEvent

文档和示例链接

EventGridFunctionOptions

此时没有特定于事件网格触发器的选项

EventGridOutputConnectionOptions
EventGridOutputKeyOptions
EventGridPartialEvent

文档和示例链接这种“部分”界面用于自己创建事件时使用,允许省略某些属性

EventGridTriggerOptions

此时没有特定于事件网格触发器的选项

EventHubFunctionOptions
EventHubOutputOptions
EventHubTriggerOptions
Exception
ExponentialBackoffRetryOptions
FixedDelayRetryOptions
FunctionInput

函数的辅助输入的完整配置(“触发器”是主要输入)注意:并非所有触发器都可以用作辅助输入

FunctionOptions

配置 Azure 函数的输入、输出和处理程序

FunctionOutput

函数输出的完整配置

FunctionTrigger

函数的主输入的完整配置

GenericFunctionOptions

配置 Azure 函数的输入、输出和处理程序

GenericInputOptions
GenericOutputOptions
GenericTriggerOptions
HookContextInit

传递给 HookContext 构造函数的对象的基础接口。 仅用于测试目的。

HttpFunctionOptions
HttpOutputOptions

此时没有特定于 http 输出的选项

HttpRequestBodyInit

仅用于测试目的。 在 Azure Functions 运行时的上下文中运行时运行时时,始终会为你构造此函数

HttpRequestInit

仅用于测试目的。 在 Azure Functions 运行时的上下文中运行时运行时时,始终会为你构造此函数

HttpRequestUser

表示通过 AppService/Functions 身份验证或 SWA 身份验证登录用户的对象

HttpResponseInit
HttpTrigger

函数的主输入的完整配置

HttpTriggerOptions
IToolPropertyBuilder

用于创建 MCP 工具属性的 Fluent API 构建器接口,这在实现与类型声明之间起到桥梁作用

InvocationContextExtraInputs

用于获取辅助输入的对象

InvocationContextExtraOutputs

用于设置辅助输出的对象

InvocationContextInit

仅用于测试目的。 在 Azure Functions 运行时的上下文中运行时运行时时,始终会为你构造此函数

InvocationHookContextInit

传入 InvocationHookContext 构造函数的对象。 仅用于测试目的

LogHookContextInit

传递给 LogHookContext 构造子的对象。 仅用于测试目的

McpAudioContentInit

初始化器。McpAudioContent data 对于 Buffer/ArrayBuffer 值,会自动以 base64 编码。

McpImageContentInit

初始化器。McpImageContent data 对于 Buffer/ArrayBuffer 值,会自动以 base64 编码。

McpPromptArgument

描述由 MCP 提示符接受的单个参数。

McpPromptFunctionOptions

MCP 提示符函数的配置选项。 这包括触发器专用选项和通用功能选项。

McpPromptTriggerOptions

MCP 提示符触发器的配置选项。 这些选项定义了触发器的行为和元数据。

McpPromptTriggerOptionsToRpc

发送给 MCP 提示符触发器的 Functions 主机的线格式选项。 promptArguments 按照主机绑定合同的要求,被序列化为 JSON 字符串。

McpResourceContentInit

初始化器。McpResourceContent blob 对于 Buffer/ArrayBuffer 值,会自动以 base64 编码。

McpResourceFunctionOptions

MCP 资源函数的配置选项。 这包括触发器专用选项和通用功能选项。

McpResourceLinkContentInit

初始化器。McpResourceLinkContent

McpResourceTriggerOptions

MCP 资源触发器的配置选项。 这些选项定义了触发器的行为和元数据。

McpToolFunctionOptions

MCP 工具函数的配置选项。 这包括触发器专用选项和通用功能选项。

McpToolProperty
McpToolResponseInit

初始化器。McpToolResponse

McpToolTriggerOptions

MCP 工具触发器的配置选项。 这些选项定义了触发器的行为和元数据。

McpToolTriggerOptionsToRpc

MCP 工具触发器的配置选项。 这些选项定义了触发器的行为和元数据。

MySqlChange
MySqlFunctionOptions
MySqlInputOptions
MySqlOutputOptions
MySqlTriggerOptions
PostInvocationContextInit

对象传递给 PostInvocationContext 构造函数。 仅用于测试目的

PreInvocationContextInit

传入 PreInvocationContext 构造函数的对象。 仅用于测试目的

RetryContext
ServiceBusQueueFunctionOptions
ServiceBusQueueOutputOptions
ServiceBusQueueTriggerOptions
ServiceBusTopicFunctionOptions
ServiceBusTopicOutputOptions
ServiceBusTopicTriggerOptions
SetupOptions
SqlChange
SqlFunctionOptions
SqlInputOptions
SqlOutputOptions
SqlTriggerOptions
StorageBlobFunctionOptions
StorageBlobOptions
StorageBlobTriggerOptions
StorageQueueFunctionOptions
StorageQueueOptions
TableInputOptions
TableOutputOptions
Timer

计时器计划信息。 使用计时器绑定时提供给函数。

TimerFunctionOptions
TimerTriggerOptions
TraceContext

用于启用分布式跟踪方案的 TraceContext 信息

WarmupContext
WarmupFunctionOptions
WarmupTriggerOptions
WebPubSubConnectionInputOptions
WebPubSubContextInputOptions
WebPubSubFunctionOptions
WebPubSubOutputOptions
WebPubSubTriggerOptions

类型别名

AppStartHandler

应用启动钩子的处理程序

AppTerminateHandler

应用终止钩子处理程序

Arg

表示工具属性定义(与 McpToolProperty 相同但不包含 propertyName)

Args

工具属性格式——将属性名称映射到其定义的对象

ConnectorTrigger
ConnectorTriggerHandler
CosmosDBChangeFeedItem
CosmosDBChangeFeedMetadata
CosmosDBFunctionOptions
CosmosDBHandler
CosmosDBInput
CosmosDBInputOptions
CosmosDBOutput
CosmosDBOutputOptions
CosmosDBTrigger
CosmosDBTriggerOptions
CosmosDBv3Handler
CosmosDBv3Input
CosmosDBv3Output
CosmosDBv3Trigger
CosmosDBv4FullFidelityFunctionOptions
CosmosDBv4FunctionOptions
CosmosDBv4Handler
CosmosDBv4Input
CosmosDBv4Output
CosmosDBv4Trigger
EventGridHandler
EventGridOutput
EventGridOutputOptions
EventGridTrigger
EventHubHandler
EventHubOutput
EventHubTrigger
FunctionHandler
FunctionResult

如果未注册任何 return 输出,则为 Void;否则,已注册的 return 输出

HttpHandler
HttpHeadersInit

表示可用于初始化 HTTP 头的头类型。 这是一个本地定义,以避免对 lib.dom 的依赖。 兼容 Node.js 原生的 Fetch API 头类型。

HttpMethod

HTTP 请求方法的可能值。

HttpMethodFunctionOptions
HttpOutput
HttpRequestParams

路由参数键和值。

HttpRequestUserType

HTTP 请求用户类型的可能值

HttpResponseBodyInit

表示可用于 HTTP 响应的正文类型。 这是一个本地定义,以避免对 lib.dom 的依赖。 兼容 Node.js 原生的 Fetch API 主体类型。 包含 Node.js 可读流和 HTTP 流场景下的异步可行流。

LogCategory
LogHandler
LogHookHandler

原木钩的处理器。

LogLevel
McpPromptArguments

用于声明提示参数的接受形状。

  • 数组形式(显式):包含 、 可选description和 required的 McpPromptArgument 对象name数组。
  • 记录/流畅表单:一个对象,其键为参数名称和值,是从 promptArg.describe(...)McpPromptArgumentBuilder 构建的实例。
McpPromptTrigger

表示一个 MCP 提示词触发器,将基础函数触发选项与 MCP 提示特定触发选项结合起来。

McpPromptTriggerHandler

用于 MCP 提示符触发器的处理程序函数。

McpResourceTrigger

表示一个 MCP 资源触发器,将基础函数触发选项与 MCP 资源特定的触发选项结合起来。

McpResourceTriggerHandler

用于 MCP 资源触发器的处理程序函数。

McpToolTrigger

表示一个 MCP 工具触发器,将基础功能触发选项与 MCP 工具专用触发选项结合起来。

McpToolTriggerHandler

用于 MCP 工具触发器的处理函数。

MySqlHandler
MySqlInput
MySqlOutput
MySqlTrigger
PostInvocationHandler

调用后钩子的处理程序

PreInvocationHandler

用于调用前钩子的处理程序。

RetryOptions
ServiceBusQueueHandler
ServiceBusQueueOutput
ServiceBusQueueTrigger
ServiceBusTopicHandler
ServiceBusTopicOutput
ServiceBusTopicTrigger
SqlHandler
SqlInput
SqlOutput
SqlTrigger
StorageBlobHandler
StorageBlobInput
StorageBlobInputOptions
StorageBlobOutput
StorageBlobOutputOptions
StorageBlobTrigger
StorageQueueHandler
StorageQueueOutput
StorageQueueOutputOptions
StorageQueueTrigger
StorageQueueTriggerOptions
TableInput
TableOutput
TimerHandler
TimerTrigger
TriggerMetadata

与触发函数的输入相关的元数据

WarmupHandler
WarmupTrigger
WebPubSubConnectionInput
WebPubSubContextInput
WebPubSubHandler
WebPubSubOutput
WebPubSubTrigger

枚举

CosmosDBv4ChangeFeedMode

更改 Cosmos DB 触发器绑定的馈送模式。

MySqlChangeOperation
SqlChangeOperation

函数

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关于返回单个内容块 参见

McpContent()

变量

arg

工厂函数用于创建新工具属性生成器

示例

const toolProperties = {
  snippetName: arg
    .string()
    .describe("Some Description"),

  optionalField: arg
    .number()
    .describe("Optional number field")
    .optional(),
};
promptArg

用于创建 MCP 提示符 参数构建器的工厂。

由于提示参数未类型化(仅 name、 description可选 和 required 标志),因此与工具属性arg助手分开。

函数详细信息

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 }