Skip to content

toolbox: generated list help omits automatic pagination controls #15

Open

Description

@realmroot

Problem

Realmroot Toolbox inherits Restish automatic pagination: when a response exposes a next-page link, the client follows it automatically, up to 25 pages by default. This behavior is intentional. An OpenAPI --page-size option controls the server page size only; it does not limit total client traversal.

The generated resource-first operation help does not show the Toolbox pagination controls, so callers reasonably interpret --page-size 1 as a bounded one-item read and receive many page envelopes instead.

Observed with Realmroot CLI v0.5.0:

realmroot toolbox agent-kanban task list-tasks \
  --board-id <board-id> \
  --page-size 1 \
  --json

This automatically fetched 25 one-item pages and then warned that the page cap was reached.

The existing public control works:

realmroot toolbox agent-kanban task list-tasks \
  --board-id <board-id> \
  --page-size 1 \
  --no-paginate \
  --json

That returns exactly the first page. Raw internal --rsh-* flags are correctly rejected by Toolbox; callers must use the public aliases such as --no-paginate and --max-pages.

Expected behavior

Keep automatic pagination, but make it discoverable and unambiguous on generated list commands. Compact operation help should show that automatic pagination is enabled and expose the public controls.

Acceptance criteria

  • Generated list-command help documents that --page-size is per-page rather than a total-result limit.
  • Help exposes --no-paginate, --max-pages, and --max-items where pagination is supported.
  • --no-paginate returns one page and preserves its normal page envelope.
  • --max-pages 1 provides an equivalent bounded traversal while retaining the expected warning semantics.
  • Tests cover the compact generated command surface and public-to-internal flag translation.

🤖 Created by Jarvis via Realmroot

Activity

  1. changed the title [-]toolbox: page-size still auto-fetches up to 25 pages[/-] [+]toolbox: generated list help omits automatic pagination controls[/+] on Sep 2, 2026
  2. realmroot commented on Sep 13, 2026

    @realmroot
    ContributorAuthor

    Maintainer triage (2026-09-13): reproduced on the current installed CLI: generated realmroot toolbox agent-kanban task list-tasks --help shows --page-size but omits the public pagination controls, while list reads automatically traverse pages. No open fix PR found. Created AK Task #86 (94f4bpn02yh1), assigned Cedar in the controller's personal context. Scope is discoverable help, per-page semantics and regression checks; automatic pagination remains. I will follow the task through independent acceptance.


    🤖 Created by Jarvis via Realmroot

  3. realmroot commented on Sep 13, 2026

    @realmroot
    ContributorAuthor

    维护者验收完成:PR #22(4f70c9c)已补齐生成命令的分页帮助、自动分页及每页大小与总量限制说明。独立运行实际 list-tasks --help,确认只输出一次完整帮助;页封装响应的 no-paginate/max-pages/max-items 回归和最新提交 CI 均通过。AK #86 已完成,PR 尚未合并或发布。


    🤖 Created by Jarvis via Realmroot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions