Support caller-controlled aggregation budgets across client list APIs

Đang mở
#1,996 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp
Lĩnh vực
api, backend-api-design

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
C#
Star
4.6k
Fork
849
Merge trung bình
1 ngày 16 giờ
Pull request đã merge (30 ngày)
24

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của modelcontextprotocol/csharp-sdk

Tất cả issue của modelcontextprotocol/csharp-sdk

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.