Support caller-controlled aggregation budgets across client list APIs

Offen
#1,996 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
csharp

Rechercherichtung

Start by reviewing the auto-paginating client list helpers for tools, prompts, resources, resource templates, and Skills, plus the related pagination decisions in #1056 and #1993. Define a consistent opt-in budget and outcome for reaching it while preserving existing defaults, cancellation, opaque cursor behavior, and page-level caching. Done means tests cover finite and non-terminating pagination, page and entry limits, cancellation, and incomplete results.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

P3

Summary

Evaluate optional, consistent maximum-page and maximum-entry budgets for the auto-paginating client list APIs for tools, prompts, resources, resource templates, and Skills.

Single-page overloads already let applications control pagination themselves. This issue concerns convenience and robustness, not missing protocol pagination support.

Motivation

The convenience methods collect pages until the server ends pagination. A faulty or untrusted server can cause non-terminating requests or unbounded accumulated results; a legitimate server can also return more data than a caller wants to retain. Cancellation can bound elapsed time, but does not directly express page or entry budgets.

The historical empty-cursor reports in #1072 and #988 were closed by design: an empty string is a valid opaque cursor, and a server must omit or return null for nextCursor to finish. Optional caller budgets should protect callers without changing that interpretation.

Proposed scope

  • Evaluate a common opt-in page/entry budget design across the SDK's aggregating list helpers, preserving existing defaults, request options, and cancellation behavior.
  • Define budget counting at page boundaries, including empty pages with continuation cursors and pages larger than the remaining entry budget.
  • Define an explicit failure or clearly incomplete outcome when a budget is reached. Never silently present a truncated list as complete.
  • Consider repeated/non-terminating cursor behavior without parsing opaque cursors or treating an empty string as null.
  • Cover finite pagination, existing unbounded defaults, page and entry limits, cancellation, and non-terminating server responses in tests.

Boundaries

Keep entry-validation and rejected-entry reporting as a separate design topic. Coordinate their counting and incomplete-result semantics, but do not make this issue depend on a new validation API.

Keep page-level caching semantics intact; this does not require an invented aggregate TTL or an SDK-owned cache.

Related work

  • Companion: #1997, strict/diagnostic entry validation. Keep the budget and validation policies independent while coordinating counting and incomplete outcomes.
  • Tarek's follow-up comment on #1993.
  • #1072 and #988 provide the historical non-terminating pagination context; they should remain closed.
  • #1056 records the decision to expose explicit page control rather than duplicate the list helpers with Enumerate*Async APIs.
  • #1993 removes Skills-only aggregation limits in favor of evaluating a consistent SDK-wide approach.

[!NOTE]
This issue was drafted with GitHub Copilot.

Vorherrschende Sprache
C#
Sterne
4.6k
Forks
849
Ø Merge
1 T. 16 Std.
Gemergte PRs (30 T.)
24

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus modelcontextprotocol/csharp-sdk

Alle Issues in modelcontextprotocol/csharp-sdk

Ähnliche Issues

Weitere Issues zu C#

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.