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