协议修订:2025-06-18
用户交互模型
提示的设计是 用户可控的,意味着它们从服务器暴露给客户端时,旨在让用户能够显式地选择使用。 通常,提示会通过用户界面上的用户发起命令触发,这样用户可以自然地发现和调用可用提示。 例如,作为斜杠命令:
能力
支持提示的服务器必须在初始化期间声明prompts 能力:
listChanged 表示服务器是否会在可用提示列表发生变化时发出通知。
协议消息
列出提示
要检索可用提示,客户端发送prompts/list 请求。此操作支持分页。
请求:
获取提示
要检索特定提示,客户端发送prompts/get 请求。参数可以通过补全API自动补全。
请求:
列表变更通知
当可用提示列表发生变化时,声明了listChanged 能力的服务器应该发送通知:
消息流程
数据类型
提示
提示定义包括:name: 提示的唯一标识符title: 可选的人类可读名称,用于显示description: 可选的人类可读描述arguments: 可选的参数列表,用于自定义
提示消息
提示中的消息可以包含:role: 为 “user” 或 “assistant”,表示说话者content: 以下内容类型之一:
所有提示消息中的内容类型都支持可选的
注解,用于标注受众、优先级和修改时间等元数据。
文本内容
文本内容表示纯文本消息:图像内容
图像内容允许在消息中包含视觉信息:音频内容
音频内容允许在消息中包含音频信息:嵌入式资源
嵌入式资源允许在消息中直接引用服务器端资源:- 有效的资源URI
- 合适的MIME类型
- 文本内容或base64编码的blob数据
错误处理
服务器应该对常见的失败情况返回标准JSON-RPC错误:- 无效的提示名称:
-32602(无效参数) - 缺少必填参数:
-32602(无效参数) - 内部错误:
-32603(内部错误)
实现注意事项
- 服务器应该在处理前验证提示参数
- 客户端应该处理大型提示列表的分页
- 双方应该尊重能力协商