Interface PaginatedRequestParams

Common parameters for paginated requests.

interface PaginatedRequestParams {
_meta?: { progressToken?: ProgressToken; [key: string]: unknown };
cursor?: string;
}

Hierarchy (View Summary)

RequestParams
- PaginatedRequestParams

Index

Properties

Properties

`Optional`_meta

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

See General fields: _meta for notes on _meta usage.

Type Declaration

[key: string]: unknown
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.

`Optional`cursor

cursor?: string

An opaque token representing the current pagination position. If provided, the server should return results starting after this cursor.