协议版本: 2024-11-05
Model Context Protocol (MCP) 通过通知消息支持对长时间运行的操作进行可选的进度跟踪。任一方都可以发送进度通知以提供操作状态的更新。

进度流程

When a party wants to 接收 progress updates for a request, it includes a progressToken in the request metadata.
  • 进度标记 必须 是字符串或整数值
  • 进度令牌可以由发送方任意选择,但必须在所有活跃请求中保持唯一。
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "some_method",
  "params": {
    "_meta": {
      "progressToken": "abc123"
    }
  }
}
The receiver 可以 then send progress notifications containing:
  • 原始进度令牌
  • 到目前为止的当前进度值
  • 一个可选的「汇总」值
{
  "jsonrpc": "2.0",
  "method": "notifications/progress",
  "params": {
    "progressToken": "abc123",
    "progress": 50,
    "total": 100
  }
}
  • progress 数值 必须 在每个通知中递增,即使总量未知。
  • progresstotal的值可以是浮点数。

行为要求

  1. 进度通知 必须 仅引用满足以下条件的令牌:
    • 在活动请求中提供
    • 与一个进行中的操作相关联
  2. 进度请求的接收者 可以
    • 选择不发送任何进度通知
    • 在他们认为合适的任何频率发送通知
    • 如果总值为未知,则忽略总计值

实现说明

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