@modelcontextprotocol/sdk
    Preparing search index...

    Interface PingRequest

    A ping, issued by either the server or the client, to check that the other party is still alive. The receiver must promptly respond, or else may be disconnected.

    interface PingRequest {
        id: RequestId;
        jsonrpc: "2.0";
        method: "ping";
        params?: {
            _meta?: { progressToken?: ProgressToken; [key: string]: unknown };
            [key: string]: unknown;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    id jsonrpc method params?

    Properties

    id: RequestId
    jsonrpc: "2.0"
    method: "ping"
    params?: {
        _meta?: { progressToken?: ProgressToken; [key: string]: unknown };
        [key: string]: unknown;
    }

    Type Declaration

    • [key: string]: unknown
    • Optional_meta?: { progressToken?: ProgressToken; [key: string]: unknown }

      See General fields: _meta for notes on _meta usage.

      • OptionalprogressToken?: ProgressToken

        If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.

    Settings

    Member Visibility

    On This Page

    Properties