Define consistent strict and diagnostic validation for client list APIs

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

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

调研方向

Start by reading related issues #1996, #1993, and #1645 to understand the aggregation boundary, prior Skills APIs, and page-level cache hints. Then inspect the client list APIs for tools, prompts, resources, resource templates, and Skills, along with their tests and source-generated serialization paths. Define the shared validation and diagnostic behavior while preserving strict defaults, pagination and fatal page errors; add the mixed-page, later-page, rejection-position, and failure tests listed in the issue.

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

描述

P3

Summary

Evaluate a consistent validation contract for client list APIs for tools, prompts, resources, resource templates, and Skills, including an optional diagnostic path that exposes usable entries alongside explicit rejected-entry details.

Preserve existing strict defaults. This is separate from how many pages or entries a caller permits the SDK to fetch.

Motivation

A single malformed entry can prevent a host from using otherwise valid entries in a listing. Hosts may want to inspect individual failures, but silently dropping invalid entries would make an incomplete result look complete.

Skills previously had dedicated ListSkillsWithDiagnosticsAsync, SkillListingResult, and SkillEntryRejection APIs. #1993 removes that Skills-only design so equivalent concepts can be evaluated consistently across the SDK.

Proposed scope

  • Document the shared validation contract and any primitive-specific checks. Passing SDK structural checks must not be described as establishing trust or, for Skills, verifying file contents/frontmatter.
  • Evaluate an explicit opt-in diagnostic API or mode that returns accepted entries and rejection details, including original entry positions and actionable errors. Do not silently omit rejected entries.
  • Preserve page boundaries, continuation cursors, and page-level cache hints where appropriate. Do not invent a single aggregate TTL.
  • Distinguish recoverable individual-entry failures from malformed JSON, invalid envelopes, or missing/null required list members where a page cannot safely be recovered. Do not turn these into success-shaped empty results.
  • Preserve ordinary RPC failure and cancellation behavior, and support the SDK's source-generated/Native AOT serialization paths.
  • Test mixed valid/invalid pages, failures on later pages, rejection positions, fatal page errors, strict defaults, and the opted-in diagnostic behavior.

Boundaries

Do not bundle aggregation budgets, caching policy, or server-side pagination infrastructure into this issue. Existing single-page APIs remain the escape hatch for application-owned policy.

Coordinate with the aggregation-budget design on entry counting and incomplete-result reporting, while keeping the two policies independent.

Related work

  • Companion: #1996, caller-controlled aggregation budgets. That issue addresses when to stop fetching; this issue addresses what to do with malformed entries.
  • #1993 motivates replacing the Skills-specific partial-result helpers with a consistent cross-SDK design.
  • #1645 records the page-level caching-hint decisions that any new result shape should preserve.

[!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 摘要。