Basic Usage
Usectx.report_progress() to send progress updates to the client. The method accepts a progress value representing how much work is complete, and an optional total representing the full scope of work.
Progress Patterns
| Pattern | Description | Example |
|---|---|---|
| Percentage | Progress as 0-100 percentage | progress=75, total=100 |
| Absolute | Completed items of a known count | progress=3, total=10 |
| Indeterminate | Progress without known endpoint | progress=files_found (no total) |
Client Requirements
Progress reporting requires clients to support progress handling. Clients must send aprogressToken in the initial request to receive progress updates. If no progress token is provided, progress calls have no effect (they don’t error).
See Client Progress for details on implementing client-side progress handling.
