Define consistent strict and diagnostic validation for client list APIs

Aberta
#1,997 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
csharp

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
C#
Estrelas
4.6k
Forks
849
Merge médio
1d 16h
PRs com merge (30d)
24

Preparar o ambiente

Abrir no Codespaces

Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de modelcontextprotocol/csharp-sdk

Todas as issues de modelcontextprotocol/csharp-sdk

Issues semelhantes

Mais issues de C#

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.