取消

ℹ️
协议修订版: 2024-11-05

Model Context Protocol (MCP) 支持通过通知消息可选地取消进行中的请求。任何一方都可以发送取消通知,以指示应终止先前发出的请求。

取消流程

当一方想要取消进行中的请求时,它会发送一个 notifications/cancelled 通知,其中包含:

  • 要取消的请求的 ID
  • 可选的用于记录或显示的原因字符串
{
  "jsonrpc": "2.0",
  "method": "notifications/cancelled",
  "params": {
    "requestId": "123",
    "reason": "用户请求取消"
  }
}

行为要求

  1. 取消通知 必须 仅引用以下请求:
    • 先前在同一方向发出的请求
    • 被认为仍在进行中的请求
  2. initialize 请求 不得 被客户端取消
  3. 取消通知的接收者
    • 停止处理被取消的请求
    • 释放相关资源
    • 不为被取消的请求发送响应
  4. 接收者 可以 忽略取消通知,如果:
    • 引用的请求未知
    • 处理已经完成
    • 请求无法取消
  5. 取消通知的发送者 忽略之后到达的请求的任何响应

时间考虑

由于网络延迟,取消通知可能会在请求处理完成后到达,甚至可能在响应已经发送后到达。

双方 必须 优雅地处理这些竞争条件:

sequenceDiagram
   participant Client
   participant Server

   Client->>Server: 请求 (ID: 123)
   Note over Server: 处理开始
   Client--)Server: notifications/cancelled (ID: 123)
   alt
      Note over Server: 处理可能在
取消到达前
完成 else 如果未完成 Note over Server: 停止处理 end

实现注意事项

  • 双方 记录取消原因以便调试
  • 应用程序 UI 在请求取消时进行指示

错误处理

无效的取消通知 被忽略:

  • 未知的请求 ID
  • 已经完成的请求
  • 格式错误的通知

这保持了通知的"发送即忘"特性,同时允许异步通信中的竞争条件。