Support caller-controlled aggregation budgets across client list APIs

未关闭
#1,996 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
csharp

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
C#
星标
4.6k
派生
849
平均合并
1 天 16 小时
30 天内合并 PR
24

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

modelcontextprotocol/csharp-sdk 的其他 Issue

查看 modelcontextprotocol/csharp-sdk 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。