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

McpResourceFunctionOptions interface

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

扩展

属性

handler

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

trigger

MCP 资源的触发器配置。

继承属性

description

资源的说明。 提供有关该资源所代表的额外背景信息。

extraInputs

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

extraOutputs

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

metadata

JSON 序列化的元数据对象。 关于资源的额外元数据,以 JSON 格式呈现。

mimeType

资源内容的 MIME 类型。 指定资源数据的格式(例如,'application/json'、'text/plain')。

resourceName

资源的可读名称。 此名称在 MCP 客户端界面中显示给用户。

return

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

size

可选大小(字节)。 资源内容的预期大小(如果已知)。

title

为展示目的,可选标题。 一个更具描述性的标题,可以在 UI 元素中显示。

uri

资源的唯一 URI 标识符(必须是绝对的)。 这是 MCP 客户端用来引用该资源的规范标识符。

属性详细信息

handler

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

handler: McpResourceTriggerHandler<T>

属性值

trigger

MCP 资源的触发器配置。

trigger?: McpResourceTrigger

属性值

继承属性详细信息

description

资源的说明。 提供有关该资源所代表的额外背景信息。

description?: string

属性值

string

继承自McpResourceTriggerOptions.description

extraInputs

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

extraInputs?: FunctionInput[]

属性值

继承自 部分。额外输入

extraOutputs

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

extraOutputs?: FunctionOutput[]

属性值

继承自 部分。额外输出

metadata

JSON 序列化的元数据对象。 关于资源的额外元数据,以 JSON 格式呈现。

metadata?: string

属性值

string

继承自McpResourceTriggerOptions.metadata

mimeType

资源内容的 MIME 类型。 指定资源数据的格式(例如,'application/json'、'text/plain')。

mimeType?: string

属性值

string

继承自McpResourceTriggerOptions.mimeType

resourceName

资源的可读名称。 此名称在 MCP 客户端界面中显示给用户。

resourceName: string

属性值

string

继承自McpResourceTriggerOptions.resourceName

return

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

return?: FunctionOutput

属性值

继承自 部分。返回

size

可选大小(字节)。 资源内容的预期大小(如果已知)。

size?: number

属性值

number

继承自McpResourceTriggerOptions.size

title

为展示目的,可选标题。 一个更具描述性的标题,可以在 UI 元素中显示。

title?: string

属性值

string

继承自McpResourceTriggerOptions.title

uri

资源的唯一 URI 标识符(必须是绝对的)。 这是 MCP 客户端用来引用该资源的规范标识符。

uri: string

属性值

string

继承自McpResourceTriggerOptions.uri