协议版本: 2025-06-18
用户交互模型
提示设计为用户控制的,意为它们由服务器向客户端公开,旨在让用户能够明确选择使用它们。 通常,提示会通过用户在界面中发起的命令触发,这使得用户能够自然地发现并调用可用的提示。 例如,以斜线命令形式:
能力
支持提示词的服务器 必须 在初始化过程中声明prompts 能力:
listChanged 表示当可用提示列表发生变化时,服务器是否会发出通知。
协议消息
展示提示项列表
要获取可用的提示信息,客户端发送一个prompts/list请求。此操作支持分页功能。
请求:
获取提示
要检索特定的提示,客户端发送一个prompts/get 请求。参数可以通过 the completion API 自动完成。
请求:
列表变更通知
当可用提示列表发生变化时,声明了listChanged
功能的服务器应当发送通知:
消息流
数据类型
提示
一个提示定义包含:name: 提示的唯一标识符title: 用于显示目的的提示的可选人类可读名称。description: 可选的人类可读描述arguments: 可选的参数列表,用于自定义
提示消息
提示消息可以包含:role: 可以是“用户”或“助手”用以标识发言者content: 以下内容类型之一:
提示消息中的所有内容类型都支持用于元数据的可选annotations(关于受众、优先级和修改时间)。
文本内容
文本内容代表纯文本消息:图像内容
图像内容允许在消息中包含视觉信息:音频内容
音频内容允许在消息中包含音频信息:嵌入资源
嵌入式资源允许直接在消息中引用服务器端资源:- 有效的资源URI
- 适当的MIME类型
- 文本内容或 base64 编码的二进制数据
错误处理
服务器 应当 针对常见故障情况返回标准的 JSON-RPC 错误:- 无效的提示名称:
-32602(无效参数) - 缺少必需的参数:
-32602(无效参数) - 内部错误:
-32603(内部错误)
实施注意事项
- 在处理之前,服务器 必须 验证 prompt 参数
- 客户端应当处理大型提示列表的分页
- 双方应尊重能力协商