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

McpPromptFunctionOptions interface

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

扩展

属性

handler

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

trigger

MCP 提示符的触发器配置。

继承属性

description

可选的提示描述。

extraInputs

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

extraOutputs

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

icons

可选的 JSON 序列化图标对象数组。

metadata

可选的 JSON 序列化元数据对象。

promptArguments

提示接受的可选参数列表。

支持两种形状:

  • 一个 McpPromptArgument 对象数组(显式)。name/description/required
  • 一个记录/流畅映射,其中 promptArg.describe(...) 键为参数名称。
promptName

提示的唯一名称。

return

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

title

可选的人类可读标题用于展示。

属性详细信息

handler

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

handler: McpPromptTriggerHandler<T>

属性值

trigger

MCP 提示符的触发器配置。

trigger?: McpPromptTrigger

属性值

继承属性详细信息

description

可选的提示描述。

description?: string

属性值

string

继承自McpPromptTriggerOptions.description

extraInputs

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

extraInputs?: FunctionInput[]

属性值

继承自 部分。额外输入

extraOutputs

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

extraOutputs?: FunctionOutput[]

属性值

继承自 部分。额外输出

icons

可选的 JSON 序列化图标对象数组。

icons?: string

属性值

string

继承自McpPromptTriggerOptions.图标

metadata

可选的 JSON 序列化元数据对象。

metadata?: string

属性值

string

继承自McpPromptTriggerOptions.metadata

promptArguments

提示接受的可选参数列表。

支持两种形状:

  • 一个 McpPromptArgument 对象数组(显式)。name/description/required
  • 一个记录/流畅映射,其中 promptArg.describe(...) 键为参数名称。
promptArguments?: McpPromptArguments

属性值

继承自McpPromptTriggerOptions.promptArguments

promptName

提示的唯一名称。

promptName: string

属性值

string

继承自McpPromptTriggerOptions.promptName。

return

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

return?: FunctionOutput

属性值

继承自 部分。返回

title

可选的人类可读标题用于展示。

title?: string

属性值

string

继承自McpPromptTriggerOptions.title