用户交互模型
提示被设计为用户控制,也就是说,服务器向客户端公开提示,是为了让用户能够明确选择并使用它们。这指的是由谁决定何时使用提示,而不是由谁编写提示内容。提示内容由服务器定义。 通常,提示会通过用户界面中由用户发起的命令触发,使用户能够自然地发现并调用可用提示。 例如,可以作为斜杠命令:
能力
支持提示的服务器 MUST 在其DiscoverResult 中声明 prompts 能力:
listChanged 表示服务器是否会在可用提示列表变化时发出通知。
声明 prompts 能力的服务器 MUST 响应 prompts/list 请求,并返回当前对请求客户端可用的一组提示。该集合 MAY 为空,也 MAY 随时间变化(见列表变化通知),但 MUST NOT 因连接不同或连接上其他请求的副作用而变化。该集合 MAY 随请求中提供的授权而变化,例如只返回调用方已授予 scope 允许的提示,因为凭据是逐请求输入,而不是连接状态。
协议消息
列出提示
为了检索可用提示,客户端会发送prompts/list 请求。此操作支持分页和缓存。
请求:
获取提示
为了检索特定提示,客户端会发送prompts/get 请求。参数可以通过补全 API自动补全。
请求:
InputRequiredResult 响应 prompts/get,表示在解析提示之前需要额外输入。这遵循多轮往返请求机制。重试请求时,客户端会在请求参数中包含 inputResponses,并在服务器提供时包含 requestState。
列表变化通知
当可用提示列表变化时,已声明listChanged 能力的服务器 SHOULD 向已打开 subscriptions/listen 流且设置了 promptsListChanged: true 的客户端发送通知:
消息流
数据类型
Prompt
提示定义包括:name:提示的唯一标识符title:用于显示的可选人类可读提示名称。description:可选的人类可读描述icons:用于在用户界面中显示的可选图标数组arguments:用于定制的可选参数列表
PromptMessage
提示中的消息可以包含:role:“user” 或 “assistant”,用于表示说话者content:以下内容类型之一:
提示消息中的所有内容类型都支持可选的
annotations,用于提供受众、优先级和修改时间等元数据。
文本内容
文本内容表示纯文本消息:图像内容
图像内容允许在消息中包含视觉信息:音频内容
音频内容允许在消息中包含音频信息:资源链接
提示消息 MAY 包含指向资源的链接,以便在不直接嵌入资源内容的情况下提供额外上下文或数据。在这种情况下,提示消息会返回一个可由客户端获取的 URI:嵌入式资源
嵌入式资源允许在消息中直接引用服务器端资源:- 有效的资源 URI
- 适当的 MIME 类型
- 文本内容或经过 base64 编码的 blob 数据
错误处理
服务器 SHOULD 针对常见失败情况返回标准 JSON-RPC 错误:- 无效提示名称:
-32602(Invalid params) - 缺少必需参数:
-32602(Invalid params) - 内部错误:
-32603(Internal error)
实现注意事项
- 服务器 SHOULD 在处理前验证提示参数
- 客户端 SHOULD 为大型提示列表处理分页
- 双方 SHOULD 遵守能力协商