@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 }