取消

ℹ️
协议版本: 2024-11-05

模型上下文协议(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
  • 已完成的请求
  • 格式错误的通知

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