MCP Server Framework - v1.0.0
    Preparing search index...

    Interface ProgressData

    Progress data for long-running operations.

    Per MCP specification, progress notifications allow tools to report incremental progress during long-running operations. The client initiates progress tracking by including a progressToken in the _meta field of the request.

    MCP Specification - notifications/progress

    // Determinate progress (e.g., processing 50 of 100 items)
    { progress: 50, total: 100, message: 'Processing item 50...' }

    // Indeterminate progress (total unknown)
    { progress: 3, message: 'Fetching data...' }
    interface ProgressData {
        message?: string;
        progress: number;
        total?: number;
    }
    Index

    Properties

    message? progress total?

    Properties

    message?: string

    Human-readable progress message.

    Optional description of current operation state. Useful for providing context to the user/LLM.

    progress: number

    Current progress value.

    Should be monotonically increasing. If total is set, must be <= total. The value itself carries no specific meaning - only relative progress matters.

    total?: number

    Total expected value for determinate progress.

    When set, progress / total represents completion percentage. Omit for indeterminate progress (spinner-style).

    Settings

    Member Visibility

    On This Page

    Properties