@azure/functions package

Clases

AppStartContext

Contexto en una aplicación de función durante el inicio de la aplicación.

AppTerminateContext

Contexto en una aplicación de función durante la terminación de la aplicación.

Disposable

Representa un tipo que puede liberar recursos, como escucha de eventos o un temporizador.

HookContext

Clase base para todos los objetos de contexto de hook

HttpRequest

Objeto de solicitud HTTP. Se proporciona a la función cuando se usan enlaces HTTP.

HttpResponse

Clase de respuesta HTTP

InvocationContext

Contiene metadatos y métodos auxiliares específicos de esta invocación

InvocationHookContext

Clase base para todos los objetos de contexto de hook de invocación

LogHookContext

Contexto en un registro

McpAudioContent

Un bloque de contenido de audio en una respuesta de una herramienta MCP.

McpContentBlock

Clase base abstracta para bloques de contenido de respuesta a la herramienta MCP.

La biblioteca Azure Functions discrimina bloques de contenido de los valores de usuario simples usando instanceof McpContentBlock, por lo que solo las instancias de las subclases integradas (McpTextContent, McpImageContent, McpAudioContent, McpResourceLinkContent, McpResourceContent) — o una subclase personalizada que extiende esta clase — serán tratadas como bloques de contenido.

Los literales de objetos simples como { type: 'text', text: '...' }no se tratan como bloques de contenido y se serializarán como texto JSON en su lugar.

Ampliación con tipos de bloque de contenido personalizados

Si la especificación MCP añade un nuevo tipo de bloque —o tu escenario necesita uno personalizado— puedes enviar tu propia subclase sin ningún cambio de librería. El convertidor solo comprueba instanceof McpContentBlock y llama JSON.stringify(block), lo que invoca a U toJSON() para producir la carga útil de cable.

Ejemplo: añadir un hipotético 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');
}

Uso de un bloque personalizado de un manejador de herramientas

// 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 },
})

Lo que la biblioteca hace por ti

  • instanceof McpContentBlock trata tu subclase de forma idéntica a los bloques incorporados.
  • Los retornos de bloque único propagan tu type cadena al resultado externo; los arrays se envuelven como multi_content_result.
  • structuredContent El manejo, la síntesis de texto de respaldo y el paso nulo se aplican sin cambios.

Lo que debes acertar en tu subclase

  • toJSON() debe devolver la forma exacta del cable que la especificación requiere para tu type.
  • Las cargas útiles binarias deben codificarse en toJSON() base64 (véase el toBase64 asistente anterior).
  • Los literales de objetos simples no se reconocen: debes construir una instancia.
McpImageContent

Un bloque de contenido de imagen en una respuesta de una herramienta MCP.

McpPromptArgumentBuilder

Fluid builder para declarar argumentos de prompt MCP en un mapa con forma promptArguments de registro. La clave del mapa proporciona el nombre del argumento.

Por defecto, los argumentos son opcionales; se requiere llamar .isRequired() para marcarlos.

Ejemplo

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

Un bloque de contenido de recursos incrustados en una respuesta de una herramienta MCP.

McpResourceLinkContent

Un bloque de contenido de enlace de recurso en una respuesta de una herramienta MCP.

McpTextContent

Un bloque de contenido de texto en una respuesta de una herramienta MCP.

McpToolResponse

Respuesta completa de la herramienta MCP con bloques de contenido explícitos y contenido estructurado opcional. Devuelve una instancia de esta clase desde un manejador de herramientas cuando necesites control total tanto sobre el array de contenido como structuredContentsobre .

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

Contexto sobre una función después de que se ejecute.

PreInvocationContext

Contexto sobre una función antes de que se ejecute.

PromptInvocationContext

Objeto de contexto estructurado pasado a los gestores de indicaciones MCP.

Proporciona acceso tipado al nombre del aviso invocado, argumentos (todos los valores son cadenas), identificador de sesión opcional y metadatos de transporte opcionales.

Ejemplo

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}`;
    }
});

Interfaces

AppStartContextInit

Objeto pasado a los constructores AppStartContext. Solo para fines de prueba

AppTerminateContextInit

Objeto pasado a los constructores AppTerminateContext. Solo para fines de prueba

ConnectorTriggerFunctionOptions
ConnectorTriggerOptions
Cookie

Objeto de cookie de respuesta HTTP a "Set-Cookie"

CosmosDBv3FunctionOptions
CosmosDBv3InputOptions
CosmosDBv3OutputOptions
CosmosDBv3TriggerOptions
CosmosDBv4AllVersionsAndDeletesFunctionOptions
CosmosDBv4ChangeFeedItem

La carga útil del elemento de cambio de alimentación de fidelidad completa emitida cuando changeFeedMode es AllVersionsAndDeletes. Los nombres de las propiedades siguen el formato de cable emitido por Cosmos DB.

CosmosDBv4ChangeFeedMetadata

Metadatos incluidos con cada elemento de cambio al usar AllVersionsAndDeletes. Los nombres de las propiedades siguen el formato de cable emitido por Cosmos DB.

CosmosDBv4InputOptions
CosmosDBv4LatestVersionFunctionOptions
CosmosDBv4OutputOptions
CosmosDBv4TriggerOptions
Duration
EffectiveFunctionOptions

Las opciones usadas al registrar la función, como se pasa a una invocación específica NOTA: Este valor puede diferir ligeramente del original porque se ha validado y los valores predeterminados se pueden haber agregado explícitamente.

EventGridEvent

Enlace a documentos y ejemplos

EventGridFunctionOptions

En este momento, no hay opciones específicas del desencadenador de Event Grid

EventGridOutputConnectionOptions
EventGridOutputKeyOptions
EventGridPartialEvent

Enlace a documentos y ejemplos Esta interfaz "parcial" está pensada para usarse al crear un evento por sí mismo y permite que algunas propiedades queden fuera

EventGridTriggerOptions

En este momento, no hay opciones específicas del desencadenador de Event Grid

EventHubFunctionOptions
EventHubOutputOptions
EventHubTriggerOptions
Exception
ExponentialBackoffRetryOptions
FixedDelayRetryOptions
FunctionInput

Configuración completa de la entrada secundaria en una función ("trigger" es la entrada principal) NOTA: No todos los desencadenadores se pueden usar como entradas secundarias.

FunctionOptions

Configura las entradas, salidas y controladores de una función de Azure.

FunctionOutput

Configuración completa de la salida en una función

FunctionTrigger

Configuración completa de la entrada principal en una función

GenericFunctionOptions

Configura las entradas, salidas y controladores de una función de Azure.

GenericInputOptions
GenericOutputOptions
GenericTriggerOptions
HookContextInit

Interfaz base para objetos pasados a constructores HookContext. Solo con fines de prueba.

HttpFunctionOptions
HttpOutputOptions

En este momento, no hay opciones específicas de salida http

HttpRequestBodyInit

Solo con fines de prueba. Esto siempre se creará para usted cuando se ejecute en el contexto del entorno de ejecución de Azure Functions.

HttpRequestInit

Solo con fines de prueba. Esto siempre se creará para usted cuando se ejecute en el contexto del entorno de ejecución de Azure Functions.

HttpRequestUser

Objeto que representa el usuario que ha iniciado sesión, ya sea a través de la autenticación appService/Functions o la autenticación swa

HttpResponseInit
HttpTrigger

Configuración completa de la entrada principal en una función

HttpTriggerOptions
IToolPropertyBuilder

Interfaz para el constructor de API Fluent para crear propiedades de la herramienta MCP Esto actúa como puente entre la implementación y las declaraciones de tipo

InvocationContextExtraInputs

Objeto usado para obtener entradas secundarias

InvocationContextExtraOutputs

Objeto usado para establecer salidas secundarias

InvocationContextInit

Solo con fines de prueba. Esto siempre se creará para usted cuando se ejecute en el contexto del entorno de ejecución de Azure Functions.

InvocationHookContextInit

Objeto pasado a los constructores InvocationHookContext. Solo para fines de prueba

LogHookContextInit

Objeto pasado a los constructores LogHookContext. Solo para fines de prueba

McpAudioContentInit

Inicializador para McpAudioContent. data está codificado automáticamente en base64 para los valores Buffer/ArrayBuffer.

McpImageContentInit

Inicializador para McpImageContent. data está codificado automáticamente en base64 para los valores Buffer/ArrayBuffer.

McpPromptArgument

Describe un único argumento aceptado por un mensaje MCP.

McpPromptFunctionOptions

Opciones de configuración para una función de aviso MCP. Esto incluye opciones específicas de disparador y opciones generales de funciones.

McpPromptTriggerOptions

Opciones de configuración para un disparador de aviso MCP. Estas opciones definen el comportamiento y los metadatos del disparador.

McpPromptTriggerOptionsToRpc

Las opciones de formato de cable enviadas al host de Funciones para un disparador de indicador MCP. promptArguments se serializa a una cadena JSON según lo requerido por el contrato de enlace del host.

McpResourceContentInit

Inicializador para McpResourceContent. blob está codificado automáticamente en base64 para los valores Buffer/ArrayBuffer.

McpResourceFunctionOptions

Opciones de configuración para una función de recurso MCP. Esto incluye opciones específicas de disparador y opciones generales de funciones.

McpResourceLinkContentInit

Inicializador para McpResourceLinkContent.

McpResourceTriggerOptions

Opciones de configuración para un disparador de recurso MCP. Estas opciones definen el comportamiento y los metadatos del disparador.

McpToolFunctionOptions

Opciones de configuración para una función de la herramienta MCP. Esto incluye opciones específicas de disparador y opciones generales de funciones.

McpToolProperty
McpToolResponseInit

Inicializador para McpToolResponse.

McpToolTriggerOptions

Opciones de configuración para un disparador de la herramienta MCP. Estas opciones definen el comportamiento y los metadatos del disparador.

McpToolTriggerOptionsToRpc

Opciones de configuración para un disparador de la herramienta MCP. Estas opciones definen el comportamiento y los metadatos del disparador.

MySqlChange
MySqlFunctionOptions
MySqlInputOptions
MySqlOutputOptions
MySqlTriggerOptions
PostInvocationContextInit

Objeto pasado a los constructores PostInvocationContext. Solo para fines de prueba

PreInvocationContextInit

Objeto pasado a los constructores PreInvocationContext. Solo para fines de prueba

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

Información de programación del temporizador. Se proporciona a la función cuando se usa un enlace de temporizador.

TimerFunctionOptions
TimerTriggerOptions
TraceContext

Información de TraceContext para habilitar escenarios de seguimiento distribuido

WarmupContext
WarmupFunctionOptions
WarmupTriggerOptions
WebPubSubConnectionInputOptions
WebPubSubContextInputOptions
WebPubSubFunctionOptions
WebPubSubOutputOptions
WebPubSubTriggerOptions

Alias de tipos

AppStartHandler

Controlador para ganchos de inicio de aplicaciones

AppTerminateHandler

Gestor para ganchos de terminación de aplicaciones

Arg

Representa una definición de propiedad de herramienta (igual que McpToolProperty pero sin propertyName)

Args

Formato de propiedades de herramienta: un objeto que asigna nombres de propiedades a sus definiciones

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

Void si no se registra ninguna salida de return; de lo contrario, la salida de return registrada

HttpHandler
HttpHeadersInit

Representa los tipos de encabezados que pueden utilizarse para inicializar encabezados HTTP. Esta es una definición local para evitar la dependencia de lib.dom. Compatible con Node.js tipos nativos de encabezados de la API Fetch.

HttpMethod

Valores posibles para un método de solicitud HTTP.

HttpMethodFunctionOptions
HttpOutput
HttpRequestParams

Enrutar las claves y los valores de los parámetros.

HttpRequestUserType

Valores posibles para un tipo de usuario solicitud HTTP

HttpResponseBodyInit

Representa los tipos de cuerpo que pueden usarse en una respuesta HTTP. Esta es una definición local para evitar la dependencia de lib.dom. Compatible con Node.js tipos nativos de cuerpo de la API de Fetch. Incluye Node.js Transmitimientos legibles y AsyncIterable para escenarios de streaming HTTP.

LogCategory
LogHandler
LogHookHandler

Manejador para ganchos de tronco.

LogLevel
McpPromptArguments

Formas aceptadas para declarar argumentos de prompt.

  • Forma de matriz (explícita): un array de objetos McpPromptArgument con name, opcional description y required.
  • Formulario de registro/fluido: un objeto cuyas claves son nombres de argumentos y valores son instancias de McpPromptArgumentBuilder construidas a partir de promptArg.describe(...).
McpPromptTrigger

Representa un disparador de Prompt MCP, combinando opciones de disparador de función base con opciones de disparador específicas de Prompt de MCP.

McpPromptTriggerHandler

Una función de manejador para los disparadores de aviso MCP.

McpResourceTrigger

Representa un disparador de recurso MCP, combinando opciones de disparador de función base con opciones de disparador específicas de recursos de MCP.

McpResourceTriggerHandler

Una función gestora para desencadenadores de recursos MCP.

McpToolTrigger

Representa un disparador de la herramienta MCP, combinando opciones de disparador de función base con opciones de disparador específicas de la herramienta MCP.

McpToolTriggerHandler

Una función de manejador para los disparadores de la herramienta MCP.

MySqlHandler
MySqlInput
MySqlOutput
MySqlTrigger
PostInvocationHandler

Gestor para ganchos posteriores a la invocación

PreInvocationHandler

Gestor para ganchos previos a la invocación.

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

Metadatos relacionados con la entrada que desencadenó la función

WarmupHandler
WarmupTrigger
WebPubSubConnectionInput
WebPubSubContextInput
WebPubSubHandler
WebPubSubOutput
WebPubSubTrigger

Enumeraciones

CosmosDBv4ChangeFeedMode

Cambiar el modo de alimentación para las asignaciones de disparadores de Cosmos DB.

MySqlChangeOperation
SqlChangeOperation

Funciones

McpContent<T>(T)

Marca una clase o función constructora como un tipo de resultado MCP que debe serializarse como contenido estructurado.

Cuando una función devuelve una instancia de un tipo decorado con este marcador, el resultado se serializará tanto como contenido de texto (para compatibilidad hacia atrás) como contenido estructurado (para clientes que lo soporten).

Sin el marcador, un objeto plano se serializa como solo texto (JSON en cadena de texto). Úsalo McpToolResponse si necesitas control explícito sobre EstructuradContent sin una clase.

Uso programático (funciona sin 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')
});

Uso de decorador (requerido experimentalDecorators: true en tsconfig):

@McpContent
class ImageMetadata { ... }

Formularios soportados:

  • @McpContent
  • @McpContent()
  • McpContent(MyClass)

Consulta McpToolResponseConsulta Para bloques de contenido explícitos + estructurado Contenido Consulta McpTextContentSee Para devolver bloques de contenido individuales

McpContent()

Variables

arg

Función de fábrica para crear una nueva herramienta de creación de propiedades

Ejemplo

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

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

Fábrica para crear constructores de argumentos de prompt MCP.

Se mantiene separado del asistente de propiedades arg de herramienta porque los argumentos de prompt no se tipifican (solo name, opcional descriptiony una required bandera).

Detalles de la función

McpContent<T>(T)

Marca una clase o función constructora como un tipo de resultado MCP que debe serializarse como contenido estructurado.

Cuando una función devuelve una instancia de un tipo decorado con este marcador, el resultado se serializará tanto como contenido de texto (para compatibilidad hacia atrás) como contenido estructurado (para clientes que lo soporten).

Sin el marcador, un objeto plano se serializa como solo texto (JSON en cadena de texto). Úsalo McpToolResponse si necesitas control explícito sobre EstructuradContent sin una clase.

Uso programático (funciona sin 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')
});

Uso de decorador (requerido experimentalDecorators: true en tsconfig):

@McpContent
class ImageMetadata { ... }

Formularios soportados:

  • @McpContent
  • @McpContent()
  • McpContent(MyClass)

Consulta McpToolResponseConsulta Para bloques de contenido explícitos + estructurado Contenido Consulta McpTextContentSee Para devolver bloques de contenido individuales

function McpContent<T>(target: T): T

Parámetros

target

T

Clase o función constructora opcional para marcar para contenido estructurado.

Devoluciones

T

La clase/función objetivo sin cambios o un decorador de clase.

McpContent()

function McpContent(): (target: T) => T

Devoluciones

(target: T) => T

Detalles de variables

arg

Función de fábrica para crear una nueva herramienta de creación de propiedades

Ejemplo

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 }

Tipo

{ boolean() => IToolPropertyBuilder, datetime() => IToolPropertyBuilder, double() => IToolPropertyBuilder, integer() => IToolPropertyBuilder, long() => IToolPropertyBuilder, number() => IToolPropertyBuilder, object() => IToolPropertyBuilder, string() => IToolPropertyBuilder }

promptArg

Fábrica para crear constructores de argumentos de prompt MCP.

Se mantiene separado del asistente de propiedades arg de herramienta porque los argumentos de prompt no se tipifican (solo name, opcional descriptiony una required bandera).

promptArg: { describe(description: string) => McpPromptArgumentBuilder }

Tipo

{ describe(description: string) => McpPromptArgumentBuilder }