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

McpToolFunctionOptions interface

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

扩展

属性

handler

触发器被调用时执行的处理程序函数。

trigger

MCP 工具的触发器配置。

继承属性

description

工具或触发器的描述。 这为触发器的目的提供了额外的背景信息。

extraInputs

在调用期间为可选辅助输入集配置,请使用 context.extraInputs.get() 获取这些值

extraOutputs

在调用期间为可选辅助输出集配置,请使用 context.extraOutputs.set() 设置这些值

metadata

JSON 序列化的元数据对象。 关于该工具的 JSON 格式的额外元数据。

resultSchema

可选的 JSON 序列化 JSON 架构,描述该工具的结构化结果。

当值提供时,该值会被验证为 JSON,并随之发送 useResultSchema: true ,以便支持结构化内容的 MCP 客户端可以使用声明的架构。

return

函数可选主输出的配置:这是在调用期间应设置为函数处理程序的返回值的主要输出

toolName

与触发器关联的工具名称。 这通常是应用设置或环境变量。

toolProperties

工具的附加属性或元数据。 可以作为数组或 Args 对象格式提供。

属性详细信息

handler

触发器被调用时执行的处理程序函数。

handler: McpToolTriggerHandler<T>

属性值

trigger

MCP 工具的触发器配置。

trigger?: McpToolTrigger

属性值

继承属性详细信息

description

工具或触发器的描述。 这为触发器的目的提供了额外的背景信息。

description: string

属性值

string

继承自McpToolTriggerOptions.description

extraInputs

在调用期间为可选辅助输入集配置,请使用 context.extraInputs.get() 获取这些值

extraInputs?: FunctionInput[]

属性值

继承自 部分。额外输入

extraOutputs

在调用期间为可选辅助输出集配置,请使用 context.extraOutputs.set() 设置这些值

extraOutputs?: FunctionOutput[]

属性值

继承自 部分。额外输出

metadata

JSON 序列化的元数据对象。 关于该工具的 JSON 格式的额外元数据。

metadata?: string

属性值

string

继承自McpToolTriggerOptions.metadata

resultSchema

可选的 JSON 序列化 JSON 架构,描述该工具的结构化结果。

当值提供时,该值会被验证为 JSON,并随之发送 useResultSchema: true ,以便支持结构化内容的 MCP 客户端可以使用声明的架构。

resultSchema?: string

属性值

string

继承自McpToolTriggerOptions.resultSchema

return

函数可选主输出的配置:这是在调用期间应设置为函数处理程序的返回值的主要输出

return?: FunctionOutput

属性值

继承自 部分。返回

toolName

与触发器关联的工具名称。 这通常是应用设置或环境变量。

toolName: string

属性值

string

继承自McpToolTriggerOptions.toolName

toolProperties

工具的附加属性或元数据。 可以作为数组或 Args 对象格式提供。

toolProperties?: McpToolProperty[] | Args

属性值

继承自McpToolTriggerOptions.toolProperties