进度

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

模型上下文协议(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
  }
}
  • 即使总计未知,progress 值也必须随每个通知增加。
  • progresstotal可以是浮点数。

行为要求

  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: 方法响应

实现注意事项

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