60e0ffc959
Upgrade checks / Notify on failure (push) Has been cancelled
Upgrade checks / Close issue on success (push) Has been cancelled
Schema Crash Test / Real-world schema crash test (232K schemas) (push) Has been cancelled
Run static analysis / static_analysis (push) Has been cancelled
Tests / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Tests / Tests with lowest-direct dependencies (push) Has been cancelled
Tests / MCP conformance tests (push) Has been cancelled
Tests / Integration tests (push) Has been cancelled
Tests / Package install smoke (push) Has been cancelled
Upgrade checks / Static analysis (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Upgrade checks / Integration tests (push) Has been cancelled
Update MCPServerConfig Schema / update-config-schema (push) Has been cancelled
Update SDK Documentation / update-sdk-docs (push) Has been cancelled
68 lines
1.5 KiB
Plaintext
68 lines
1.5 KiB
Plaintext
---
|
|
title: Progress Monitoring
|
|
sidebarTitle: Progress
|
|
description: Handle progress notifications from long-running server operations.
|
|
icon: bars-progress
|
|
---
|
|
|
|
import { VersionBadge } from '/snippets/version-badge.mdx'
|
|
|
|
<VersionBadge version="2.3.5" />
|
|
|
|
Use this when you need to track progress of long-running operations.
|
|
|
|
MCP servers can report progress during operations. The client receives these updates through a progress handler.
|
|
|
|
## Progress Handler
|
|
|
|
Set a handler when creating the client:
|
|
|
|
```python
|
|
from fastmcp import Client
|
|
|
|
async def progress_handler(
|
|
progress: float,
|
|
total: float | None,
|
|
message: str | None
|
|
) -> None:
|
|
if total is not None:
|
|
percentage = (progress / total) * 100
|
|
print(f"Progress: {percentage:.1f}% - {message or ''}")
|
|
else:
|
|
print(f"Progress: {progress} - {message or ''}")
|
|
|
|
client = Client(
|
|
"my_mcp_server.py",
|
|
progress_handler=progress_handler
|
|
)
|
|
```
|
|
|
|
The handler receives three parameters:
|
|
|
|
<Card icon="code" title="Handler Parameters">
|
|
<ResponseField name="progress" type="float">
|
|
Current progress value
|
|
</ResponseField>
|
|
|
|
<ResponseField name="total" type="float | None">
|
|
Expected total value (may be None if unknown)
|
|
</ResponseField>
|
|
|
|
<ResponseField name="message" type="str | None">
|
|
Optional status message
|
|
</ResponseField>
|
|
</Card>
|
|
|
|
## Per-Call Handler
|
|
|
|
Override the client-level handler for specific tool calls:
|
|
|
|
```python
|
|
async with client:
|
|
result = await client.call_tool(
|
|
"long_running_task",
|
|
{"param": "value"},
|
|
progress_handler=my_progress_handler
|
|
)
|
|
```
|