Skip to content

SDK/TUI: add high-level parity coverage, documentation, and examples #1471

Closed

Description

@samuv

Parent story: #1466

Goal

Make high-level SDK coverage intentional and regression-resistant, and document which mecatui behaviors belong in the SDK versus the application or operator layer.

Scope

  • Inventory every public RPC and classify it as a Session method, SDK namespace operation, lifecycle object, or intentionally raw-only operation.
  • Inventory every mecatui builtin and classify it as SDK-backed, application/presentation-only, operator/configuration-only, or debug-only.
  • Record a short rationale for every intentionally raw-only RPC and every builtin that should not become an SDK API.
  • Add a high-level surface coverage test in addition to the existing raw RPC reachability/parity check.
  • Update generated/public API reports for intentional surface changes.
  • Add user documentation and runnable examples for the session lifecycle, capability discovery, MCP enrollment, and MCP authorization workflows delivered by the sibling sub-issues.
  • Update the TypeScript SDK changelog and any relevant living architecture documentation.

Boundaries

  • Coverage does not mean one SDK method per RPC or one SDK method per TUI command.
  • Do not expose presentation-only actions such as help, quit, overlays, filtering, keybindings, clipboard behavior, or debug prompts.
  • Do not move local provider configuration, credential management, or TUI preference persistence into the SDK.

Acceptance criteria

  • The RPC and TUI-builtin classifications are checked in and leave no unclassified entries.
  • CI fails when a new public RPC or builtin is added without an explicit high-level-surface classification.
  • The coverage mechanism distinguishes raw transport reachability from ergonomic high-level coverage.
  • Documentation explains the authority boundary: server logic, SDK protocol choreography, and application presentation/policy.
  • Examples compile/run under the repository's normal SDK verification workflow.
  • Public API reports and changelog entries match the shipped SDK surface.

Activity

  1. added
    documentationImprovements or additions to documentation
    enhancementNew feature or request
    tuimecatui terminal UI (rendering, keybindings, footer, panes, scrollback)
    on Sep 14, 2026
  2. self-assigned this
    on Sep 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

devexdocumentationImprovements or additions to documentationenhancementNew feature or requesttuimecatui terminal UI (rendering, keybindings, footer, panes, scrollback)

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions