Frodo Library - v4.5.0
    Preparing search index...

    Type Alias McpExecutionPaginationMetadata

    Pagination metadata returned for list/search style tool calls.

    When McpExecutionPaginationMetadata.hasMore is present, the result was actually sliced by the runtime's default response-size safety net (see applyResponseSizeLimit) before being returned — not just flagged as possibly truncated. nextPageOffset is always a usable continuation value in that case.

    type McpExecutionPaginationMetadata = {
        hasMore?: boolean;
        includeTotalRequested?: boolean;
        isPartial: boolean;
        nextPageOffset?: number;
        requestedPageOffset?: number;
        requestedPageSize?: number;
        requestedPageToken?: string;
        returnedCount?: number;
        totalCount?: number;
        warning?: string;
    }
    Index

    Properties

    hasMore? includeTotalRequested? isPartial nextPageOffset? requestedPageOffset? requestedPageSize? requestedPageToken? returnedCount? totalCount? warning?

    Properties

    hasMore?: boolean

    Whether more items remain past the returned page.

    includeTotalRequested?: boolean

    Whether caller requested exact totals.

    isPartial: boolean

    Whether the result appears to be truncated/paginated.

    nextPageOffset?: number

    Offset to pass as pageOffset to fetch the next page, when hasMore is true.

    requestedPageOffset?: number

    Requested page offset hint, if provided by caller.

    requestedPageSize?: number

    Requested page size hint, if provided by caller.

    requestedPageToken?: string

    Requested page token hint, if provided by caller.

    returnedCount?: number

    Number of rows returned when the payload is an array.

    totalCount?: number

    Total number of rows available before truncation, when known.

    warning?: string

    Optional advisory warning for agent callers.

    Settings

    Member Visibility

    On This Page

    Properties