协议版本: 2025-03-26
用户交互模型
提示被设计为用户控制的,这意味着它们从服务器公开给客户端,目的是让用户能够明确地选择它们使用。 通常,提示会通过用户界面中的用户发起命令触发,这使用户能够自然地发现和调用可用的提示。 例如,作为斜杠命令:
然而,实现者可以通过任何适合其需求的界面模式公开提示—协议本身不强制要求任何特定的用户交互模型。
能力
支持提示的服务器必须在初始化期间声明prompts能力:
listChanged表示服务器是否会在可用提示列表更改时发出通知。
协议消息
列出提示
要检索可用的提示,客户端发送prompts/list请求。此操作支持分页。
请求:
获取提示
要检索特定提示,客户端发送prompts/get请求。参数可以通过补全API自动完成。
请求:
列表变更通知
当可用提示列表发生变化时,声明了listChanged能力的服务器应该发送通知:
消息流
数据类型
提示
提示定义包括:name:提示的唯一标识符description:可选的人类可读描述arguments:用于自定义的可选参数列表
提示消息
提示中的消息可以包含:role:表示发言者的”user”或”assistant”content:以下内容类型之一:
文本内容
文本内容表示纯文本消息:图像内容
图像内容允许在消息中包含视觉信息:音频内容
音频内容允许在消息中包含音频信息:嵌入资源
嵌入资源允许在消息中直接引用服务器端资源:- 有效的资源URI
- 适当的MIME类型
- 文本内容或base64编码的blob数据
错误处理
服务器应该为常见失败情况返回标准JSON-RPC错误:- 无效的提示名称:
-32602(无效参数) - 缺少必需参数:
-32602(无效参数) - 内部错误:
-32603(内部错误)
实施考虑
- 服务器应该在处理前验证提示参数
- 客户端应该处理大型提示列表的分页
- 双方应该尊重能力协商