Define consistent strict and diagnostic validation for client list APIs

Aperta
#1,997 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
csharp

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
C#
Stelle
4.6k
Fork
849
Merge medio
1g 16h
PR unite (30g)
24

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di modelcontextprotocol/csharp-sdk

Tutte le issue di modelcontextprotocol/csharp-sdk

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.