MCP Academy · 课时

为长任务发送进度

向客户端流式发送完成百分比更新。

第 1 / 4 课13 个步骤

为长任务发送进度 是 CoddyKit 上的免费 MCP Academy 课时。 这是第 1 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 MCP Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 MCP Academy 课程共包含 4 节课。

进度为何重要

当工具需要运行几秒或几分钟时,客户端不应只是停在那里。MCP 允许服务器发送进度更新,让用户看到工作正在推进。

进度令牌

客户端会在请求中附加 progressToken 来选择启用此功能。没有该令牌时,服务器就不会发送更新。

访问上下文对象

在 Python SDK 中,工具会接收一个 Context 对象。它是您在调用过程中与客户端通信的句柄,也包括发送进度信息。

from mcp.server.fastmcp import Context

@mcp.tool()
async def crunch(n: int, ctx: Context) -> str:
    return "done"

调用 report_progress

要推送更新,请调用 ctx.report_progress。每次调用都会告诉客户端工作已经进行到哪一步。

await ctx.report_progress(progress=3, total=10)

进度与总量

总量参数表示终点。客户端可以用进度除以总量,绘制一条向用户显示完成百分比的进度条。

await ctx.report_progress(progress=5, total=10)  # 50%

在循环中更新

报告进度的自然位置是在工作循环内部。每完成一个数据块,就发送一次更新,让进度条稳步前进。

for i, item in enumerate(items):
    process(item)
    await ctx.report_progress(i + 1, len(items))

没有总量的进度

有时您无法预先知道总量。此时可以省略它;客户端会显示不确定进度的加载指示器,而不是精确的进度条。

await ctx.report_progress(progress=42)  # total unknown

添加可选消息

许多 SDK 版本允许您在进度调用中附加简短的消息,例如“正在索引文件”,为用户提供易懂的上下文。

await ctx.report_progress(2, 5, message="Fetching pages")

这是一条通知

进度通过 JSON-RPC通知传输,因此没有回复,也不会阻塞。工具会继续工作,同时不断发出更新。

保持合理的更新频率

不要向客户端发送数千条细小的更新。请在有意义的步骤进行报告,让信息流保持实用且轻量。

进度加上结果

进度通知与工具的返回值彼此独立。您可以在工作过程中持续发送更新,最后再返回最终结果。

await ctx.report_progress(10, 10)
return "index built"

快速检查

测试您对进度报告如何开始的理解。

总结:进度

您已经学会使用进度和总量调用 ctx.report_progress,在循环中发送更新,并让客户端绘制实时进度条。做得不错!

免费开始

用 AI 导师学习 Python — 免费

在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。

课程
30
课程
120

常见问题解答

「为长任务发送进度」课时是免费的吗?

是的 — 「为长任务发送进度」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 MCP Academy 课程的其余内容,请升级到 CoddyKit PRO。 MCP Academy 课程共包含 4 节课。

「为长任务发送进度」这节课中我会学到什么?

向客户端流式发送完成百分比更新。 你通过在浏览器中直接运行的动手代码来练习 MCP Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 MCP Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 MCP Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 4 节。

「为长任务发送进度」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 MCP Academy 课中编写并运行代码吗?

能。每节 MCP Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 为长任务发送进度
  2. 处理取消请求
  3. 向客户端发送结构化日志
  4. 在运行时设置日志级别
← 返回 MCP Academy