Define consistent strict and diagnostic validation for client list APIs

オープン
#1,997 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
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時間
マージ済み PR(30日)
24

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

modelcontextprotocol/csharp-sdk のほかの issue

modelcontextprotocol/csharp-sdk の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。