为简洁起见,本页的请求示例省略了
_meta 请求元数据(io.modelcontextprotocol/protocolVersion、io.modelcontextprotocol/clientInfo 和 io.modelcontextprotocol/clientCapabilities)。每个请求**必须(MUST)**包含必需的 _meta 字段;参见 _meta。用户交互模型
提示被设计为由用户控制,意味着它们从服务器暴露给客户端,意图是让用户能够显式地选择使用它们。这指的是谁决定何时使用提示,而不是谁编写其内容。提示内容由服务器定义。 通常,提示会通过用户界面中由用户发起的命令触发,这允许用户自然地发现和调用可用的提示。 例如,作为斜杠命令:
能力
支持提示的服务器**必须(MUST)**在其DiscoverResult 中声明 prompts 能力:
listChanged 指示服务器是否会在可用提示列表变化时发出通知。
声明 prompts 能力的服务器**必须(MUST)以当前对发起请求的客户端可用的提示集合响应 prompts/list 请求。此集合可以(MAY)为空并可以(MAY)随时间变化(参见列表变更通知),但不得(MUST NOT)按连接变化或作为连接上其他请求的副作用变化。此集合可以(MAY)**按请求上出示的授权变化——例如,只返回调用方被授予的 scope 所允许的提示——因为凭据是每请求输入,而非连接状态。
协议消息
列出提示
要检索可用的提示,客户端发送一个prompts/list 请求。此操作支持分页和缓存。
请求:
获取一个提示
要检索一个特定的提示,客户端发送一个prompts/get 请求。参数可以通过补全 API自动补全。
请求:
InputRequiredResult 响应 prompts/get,以表明在提示可以被解析之前需要额外的输入。这遵循多轮往返请求机制。在重试请求时,客户端在请求参数中包含 inputResponses,以及(如果服务器提供)requestState。
列表变更通知
当可用提示列表变化时,声明了listChanged 能力的服务器**应当(SHOULD)**向已用 promptsListChanged: true 打开一个 subscriptions/listen 流的客户端发送一个通知:
消息流
数据类型
Prompt
一个提示定义包括:name:提示的唯一标识符title:用于显示目的的可选人类可读提示名称。description:可选的人类可读描述icons:用于在用户界面中显示的可选图标数组arguments:用于自定义的可选参数列表
PromptMessage
提示中的消息可以包含:role:“user” 或 “assistant”,以指示说话者content:以下内容类型之一:
提示消息中的所有内容类型都支持可选的注解,用于关于受众、优先级和修改时间的元数据。
文本内容
文本内容表示纯文本消息:图像内容
图像内容允许在消息中包含视觉信息:音频内容
音频内容允许在消息中包含音频信息:资源链接
提示消息**可以(MAY)**包含到资源的链接,以在不直接嵌入资源内容的情况下提供额外的上下文或数据。在这种情况下,提示消息返回一个客户端可以获取的 URI:嵌入的资源
嵌入的资源允许在消息中直接引用服务器端资源:- 一个有效的资源 URI
- 适当的 MIME 类型
- 文本内容或 base64 编码的 blob 数据
错误处理
服务器**应当(SHOULD)**为常见的失败情况返回标准的 JSON-RPC 错误:- 无效的提示名:
-32602(Invalid params) - 缺少必需的参数:
-32602(Invalid params) - 内部错误:
-32603(Internal error)
实现考量
- 服务器**应当(SHOULD)**在处理之前校验提示参数
- 客户端**应当(SHOULD)**为大型提示列表处理分页
- 双方**应当(SHOULD)**尊重能力协商