@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface TaskRequestHandlerExtraExperimental

    Extended handler extra with task ID and store for task operations.

    interface TaskRequestHandlerExtra {
        taskId: string;
        taskStore: RequestTaskStore;
        signal: AbortSignal;
        authInfo?: AuthInfo;
        sessionId?: string;
        _meta?: {
            progressToken?: string | number;
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            [key: string]: unknown;
        };
        requestId: RequestId;
        taskRequestedTtl?: number
        | null;
        requestInfo?: RequestInfo;
        sendNotification: (notification: ServerNotification) => Promise<void>;
        sendRequest: <U extends AnySchema>(
            request: ServerRequest,
            resultSchema: U,
            options?: TaskRequestOptions,
        ) => Promise<SchemaOutput<U>>;
        closeSSEStream?: () => void;
        closeStandaloneSSEStream?: () => void;
    }

    Hierarchy

    • RequestHandlerExtra<ServerRequest, ServerNotification>
      • TaskRequestHandlerExtra
    Index

    Properties

    taskId taskStore signal authInfo? sessionId? _meta? requestId taskRequestedTtl? requestInfo? sendNotification sendRequest closeSSEStream? closeStandaloneSSEStream?

    Properties

    taskId: string
    taskStore: RequestTaskStore
    signal: AbortSignal

    An abort signal used to communicate if the request was cancelled from the sender's side.

    authInfo?: AuthInfo

    Information about a validated access token, provided to request handlers.

    sessionId?: string

    The session ID from the transport, if available.

    Optional Experimental_meta

    _meta?: {
        progressToken?: string | number;
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        [key: string]: unknown;
    }

    Metadata from the original request.

    Type Declaration

    • [key: string]: unknown
    • OptionalprogressToken?: string | number

      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.

    • Optionalio.modelcontextprotocol/related-task?: { taskId: string }

      If specified, this request is related to the provided task.

    requestId: RequestId

    The JSON-RPC ID of the request being handled. This can be useful for tracking or logging purposes.

    taskRequestedTtl?: number | null
    requestInfo?: RequestInfo

    The original HTTP request.

    sendNotification: (notification: ServerNotification) => Promise<void>

    Sends a notification that relates to the current request being handled.

    This is used by certain transports to correctly associate related messages.

    sendRequest: <U extends AnySchema>(
        request: ServerRequest,
        resultSchema: U,
        options?: TaskRequestOptions,
    ) => Promise<SchemaOutput<U>>

    Sends a request that relates to the current request being handled.

    This is used by certain transports to correctly associate related messages.

    closeSSEStream?: () => void

    Closes the SSE stream for this request, triggering client reconnection. Only available when using StreamableHTTPServerTransport with eventStore configured. Use this to implement polling behavior during long-running operations.

    closeStandaloneSSEStream?: () => void

    Closes the standalone GET SSE stream, triggering client reconnection. Only available when using StreamableHTTPServerTransport with eventStore configured. Use this to implement polling behavior for server-initiated notifications.

    Settings

    Member Visibility

    On This Page

    Properties