协议修订版: draft
用户交互模型
提示词被设计为用户控制的,这意味着它们从服务器暴露给客户端,目的是让用户能够明确选择使用它们。 通常,提示词会通过用户界面中的用户发起命令来触发,这允许用户自然地发现和调用可用的提示词。 例如,作为斜杠命令:
能力
支持提示词的服务器必须在初始化期间声明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(内部错误)
实现注意事项
- 服务器应该在处理前验证提示词参数
- 客户端应该处理大型提示词列表的分页
- 双方应该尊重能力协商