@modelcontextprotocol/sdk
    Preparing search index...

    Interface ProgressNotification

    An out-of-band notification used to inform the receiver of a progress update for a long-running request.

    interface ProgressNotification {
        jsonrpc: "2.0";
        method: "notifications/progress";
        params: {
            message?: string;
            progress: number;
            progressToken: ProgressToken;
            total?: number;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    jsonrpc method params

    Properties

    jsonrpc: "2.0"
    method: "notifications/progress"
    params: {
        message?: string;
        progress: number;
        progressToken: ProgressToken;
        total?: number;
    }

    Type Declaration

    • Optionalmessage?: string

      An optional message describing the current progress.

    • progress: number

      The progress thus far. This should increase every time progress is made, even if the total is unknown.

      number

    • progressToken: ProgressToken

      The progress token which was given in the initial request, used to associate this notification with the request that is proceeding.

    • Optionaltotal?: number

      Total number of items to process (or total progress required), if known.

      number

    Settings

    Member Visibility

    On This Page

    Properties