Skip to main content

Module progress

Module progress 

Source
Expand description

Host-side progress reporting for long-running plugin work — a FACILITY, not part of the plugin wire contract. Plugins call report at natural milestones (a page fetched, a file downloaded); the host decides where the lines go. Default: stderr, which every surface tolerates (the CLI shows it live; MCP stdout stays pure JSON-RPC). Future stdio plugins map their stderr onto the same sink — the contract itself stays untouched.

Functions§

report
One short line of progress (“142 messages (3 pages)…”). Cheap enough to call in loops at coarse milestones; never call per record.
set_sink
Route progress lines somewhere other than stderr (a UI, a log).