@azure/functions package

الفصول

AppStartContext

السياق حول تطبيق وظيفة أثناء بدء تشغيل التطبيق.

AppTerminateContext

السياق على تطبيق وظيفة أثناء إنهاء التطبيق.

Disposable

يمثل نوعا يمكنه تحرير الموارد، مثل الاستماع إلى الأحداث أو المؤقت.

HookContext

الفئة الأساسية لجميع كائنات السياق الخطاف

HttpRequest

كائن طلب HTTP. يتم توفيرها إلى الدالة عند استخدام روابط HTTP.

HttpResponse

فئة استجابة HTTP

InvocationContext

يحتوي على بيانات التعريف وأساليب المساعد الخاصة بهذا الاستدعاء

InvocationHookContext

الفئة الأساسية لجميع كائنات سياق خطاف الاستدعاء

LogHookContext

السياق على سجل

McpAudioContent

كتلة محتوى صوتي في استجابة أداة MCP.

McpContentBlock

فئة أساسية مجردة لكتل محتوى استجابة أداة MCP.

تميز مكتبة دالات Azure بين كتل المحتوى وقيم المستخدم العادية باستخدام instanceof McpContentBlock، لذا سيتم التعامل فقط مع نسخ الفئات الفرعية المدمجة (McpTextContent، McpImageContent، McpAudioContent، McpResourceLinkContentMcpResourceContent، ) — أو الفئة الفرعية المخصصة التي توسع هذه الفئة — ككتل محتوى.

الأشكال الحرفية للكائنات العادية مثل { 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 المعالجة، وتركيب النص الاحتياطي، والتمرير الفارغ كلها تنطبق دون تغيير.

ما يجب أن تحصل عليه بشكل صحيح في فئتك الفرعية

  • toJSON() يجب أن تعيد شكل السلك الدقيق الذي تتطلبه المواصفات ل type.
  • يجب ترميز الحمولات الثنائية بنظام base64 ( toJSON() انظر المساعد toBase64 أعلاه).
  • لا يتم التعرف على الحروف البسيطة — يجب عليك إنشاء مثيل.
McpImageContent

كتلة محتوى الصورة في استجابة أداة MCP.

McpPromptArgumentBuilder

منشئ سلس لإعلان حجج MCP في خريطة على شكل promptArguments سجلات. مفتاح الخريطة يوفر اسم الوسيط.

بشكل افتراضي، الوسائط اختيارية؛ استدعى .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.

يوفر وصولا مكتوبا إلى اسم المطالبة المستدعى، والوسائط (جميع القيم هي سلاسل نصية)، ومعرف الجلسة الاختياري، وبيانات النقل الاختيارية.

مثال

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 إلى "Set-Cookie"

CosmosDBv3FunctionOptions
CosmosDBv3InputOptions
CosmosDBv3OutputOptions
CosmosDBv3TriggerOptions
CosmosDBv4AllVersionsAndDeletesFunctionOptions
CosmosDBv4ChangeFeedItem

تغيير عنصر التغذية بالدقة الكاملة المنبعث عندما changeFeedMode يكون .AllVersionsAndDeletes تتبع أسماء الخصائص تنسيق الأسلاك الذي يصدره 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

HttpRequestInit

لأغراض الاختبار فقط. سيتم إنشاء هذا دائما لك عند التشغيل في سياق وقت تشغيل دالات Azure

HttpRequestUser

كائن يمثل المستخدم الذي قام بتسجيل الدخول، إما من خلال مصادقة AppService/Functions، أو مصادقة SWA

HttpResponseInit
HttpTrigger

التكوين الكامل للإدخال الأساسي إلى دالة

HttpTriggerOptions
IToolPropertyBuilder

واجهة لمنشئ API السائق لإنشاء خصائص أداة MCP تعمل كجسر بين الإعلانات التنفيذية وإعلانات النوع

InvocationContextExtraInputs

كائن يستخدم للحصول على مدخلات ثانوية

InvocationContextExtraOutputs

كائن يستخدم لتعيين المخرجات الثانوية

InvocationContextInit

لأغراض الاختبار فقط. سيتم إنشاء هذا دائما لك عند التشغيل في سياق وقت تشغيل دالات Azure

InvocationHookContextInit

تم تمرير الكائن إلى منشئي InvocationHookContext. لأغراض الاختبار فقط

LogHookContextInit

الكائن يمرر إلى منشئي LogHookContext. لأغراض الاختبار فقط

McpAudioContentInit

المهيئ ل McpAudioContent. data يتم ترميز base64 تلقائيا لقيم Buffer/ArrayBuffer.

McpImageContentInit

المهيئ ل McpImageContent. data يتم ترميز base64 تلقائيا لقيم Buffer/ArrayBuffer.

McpPromptArgument

يصف وسيطة واحدة مقبولة من قبل موجه MCP.

McpPromptFunctionOptions

خيارات التكوين لوظيفة موجه MCP. يشمل ذلك خيارات خاصة بالمشغلات وخيارات الوظائف العامة.

McpPromptTriggerOptions

خيارات التكوين لمحفز موجه MCP. تحدد هذه الخيارات السلوك والبيانات الوصفية للمشغل.

McpPromptTriggerOptionsToRpc

خيارات تنسيق السلك المرسلة إلى مضيف الوظائف لتشغيل موجه MCP. promptArguments يتم تسلسله إلى سلسلة JSON كما هو مطلوب في عقد الربط المضيف.

McpResourceContentInit

المهيئ ل McpResourceContent. blob يتم ترميز base64 تلقائيا لقيم Buffer/ArrayBuffer.

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 وإلا، فإن إخراج return المسجل

HttpHandler
HttpHeadersInit

يمثل أنواع الرؤوس التي يمكن استخدامها لتهيئة رؤوس HTTP. هذا تعريف محلي لتجنب الاعتماد على lib.dom. متوافق مع أنواع رؤوس API الأصلية Node.js Fetch.

HttpMethod

القيم المحتملة لأسلوب طلب HTTP.

HttpMethodFunctionOptions
HttpOutput
HttpRequestParams

مفاتيح وقيم معلمات المسار.

HttpRequestUserType

القيم المحتملة لنوع مستخدم طلب HTTP

HttpResponseBodyInit

يمثل أنواع الجسم التي يمكن استخدامها في استجابة HTTP. هذا تعريف محلي لتجنب الاعتماد على lib.dom. متوافق مع Node.js أنواع أجسام API الأصلية في Fetch. يتضمن Node.js تدفقات قابلة للقراءة وسيناريوهات البث غير المتزامنة لبث HTTP.

LogCategory
LogHandler
LogHookHandler

متحكم في خطافات الأخشاب.

LogLevel
McpPromptArguments

الأشكال المقبولة لإعلان وسائط الطلب.

  • شكل المصفوفة (صريح): مصفوفة من كائنات McpPromptArgument مع name، اختياري description و required.
  • شكل سجل/سلسة: كائن مفاتيحه أسماء وسيطات وقيم هي مثيلات McpPromptArgumentBuilder مبنية من promptArg.describe(...).
McpPromptTrigger

يمثل مشغل موجه MCP، يجمع بين خيارات المشغلات الأساسية للوظيفة مع خيارات المشغلات الخاصة ب MCP.

McpPromptTriggerHandler

دالة معالجة لمحفزات MCP Prompt.

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 متسلسل). استخدم 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 .

يتم الاحتفاظ به منفصلا عن مساعد خاصية arg الأداة لأن وسائط المطالبة غير مكتوبة (فقط name، اختياري description، وعلم required ).

تفاصيل الوظيفة

McpContent<T>(T)

يحدد فئة أو دالة منشئ كنوع نتيجة MCP يجب تسلسله كمحتوى منظم.

عندما تعيد دالة نسخة من نوع مزين بهذا العلامة، سيتم تسلسلها كمحتوى نصي (للتوافق مع الإصدارات السابقة) ومحتوى منظم (للعملاء الذين يدعمونه).

بدون العلامة، يتم تسلسل الكائن العادي كنص فقط (JSON متسلسل). استخدم 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 .

يتم الاحتفاظ به منفصلا عن مساعد خاصية arg الأداة لأن وسائط المطالبة غير مكتوبة (فقط name، اختياري description، وعلم required ).

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

النوع

{ describe(description: string) => McpPromptArgumentBuilder }