规范
规范
概述
实用工具
进度

进度

协议版本：2025-03-26

模型上下文协议 (MCP) 通过通知消息支持可选的长时间运行操作的进度跟踪。任一方都可以发送进度通知以提供操作状态更新。

进度流程

当一方想要_接收_请求的进度更新时，它在请求元数据中包含 progressToken。

  • 进度令牌必须是字符串或整数值
  • 进度令牌可以由发送者使用任何方式选择，但必须在所有活动请求中唯一
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "some_method",
  "params": {
    "_meta": {
      "progressToken": "abc123"
    }
  }
}

接收者可以然后发送包含以下内容的进度通知：

  • 原始进度令牌
  • 当前进度值
  • 可选的"总计"值
  • 可选的"消息"值
{
  "jsonrpc": "2.0",
  "method": "notifications/progress",
  "params": {
    "progressToken": "abc123",
    "progress": 50,
    "total": 100,
    "message": "Reticulating splines..."
  }
}
  • progress 值必须随着每个通知增加，即使总数未知。
  • progress 和 total 值可以是浮点数。
  • message 字段应该提供相关的人类可读进度信息。

行为要求

  1. 进度通知必须仅引用：

    • 在活动请求中提供的令牌
    • 与进行中操作关联的令牌

  2. 进度请求的接收者可以：

    • 选择不发送任何进度通知
    • 以他们认为适当的频率发送通知
    • 如果未知，则省略总计值
  sequenceDiagram
    participant Sender
    participant Receiver

    Note over Sender,Receiver: 带有进度令牌的请求
    Sender->>Receiver: 带有 progressToken 的方法请求

    Note over Sender,Receiver: 进度更新
    loop 进度更新
        Receiver-->>Sender: 进度通知 (0.2/1.0)
        Receiver-->>Sender: 进度通知 (0.6/1.0)
        Receiver-->>Sender: 进度通知 (1.0/1.0)
    end

    Note over Sender,Receiver: 操作完成
    Receiver->>Sender: 方法响应

实现注意事项

  • 发送者和接收者应该跟踪活动进度令牌
  • 双方应该实施速率限制以防止泛滥
  • 进度通知必须在完成后停止
Ping