modelcontextprotocol/csharp-sdk
Watch
1
0
Fork
You've already forked csharp-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Release v1.1.0 (#1411)

Browse source 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Jeff Handley 2026-03-06 12:52:11 -08:00 • committed by GitHub
commit ca040d77ec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 888 additions and 235 deletions
Download patch file Download diff file Expand all files Collapse all files

204
.github/skills/prepare-release/references/apicompat-apidiff.md vendored Normal file
View file

@ -0,0 +1,204 @@
# API Compatibility and Diff Guide
This reference describes how to run API compatibility checks and generate API diff reports for the C# MCP SDK release process.
## API Compatibility Check (ApiCompat)
The SDK uses NuGet's [Package Validation](https://learn.microsoft.com/dotnet/fundamentals/package-validation/overview) to verify API compatibility between releases. This is configured in `src/Directory.Build.props`:
```xml
<EnablePackageValidation>true</EnablePackageValidation>
<PackageValidationBaselineVersion>1.0.0</PackageValidationBaselineVersion>
```
### Running ApiCompat
1. **Pack the SDK packages** to trigger validation:
```sh
dotnet pack src/ModelContextProtocol.Core/ModelContextProtocol.Core.csproj
dotnet pack src/ModelContextProtocol/ModelContextProtocol.csproj
dotnet pack src/ModelContextProtocol.AspNetCore/ModelContextProtocol.AspNetCore.csproj
```
Or pack all at once:
```sh
dotnet pack
```
2. **Capture the output.** Package validation compares the current public API against the baseline version downloaded from NuGet. Any compatibility issues appear as build warnings or errors.
3. **Interpret results:**
- **No issues**: The API is backward-compatible with the baseline. This is the expected result for PATCH and MINOR releases.
- **Compatibility errors**: The API has breaking changes relative to the baseline. These should align with the breaking change audit from Step 3 of the prepare-release skill.
- **Suppressions needed**: If intentional breaking changes are confirmed, add entries to `CompatibilitySuppressions.xml` in the affected project directory.
### Updating the Baseline Version
- **MAJOR version bump**: Update `<PackageValidationBaselineVersion>` to the previous release version so that ApiCompat validates against the last stable release of the prior MAJOR version. After the new MAJOR release is published, the baseline stays at the new version for future comparisons.
- **MINOR or PATCH version bump**: Keep `<PackageValidationBaselineVersion>` at the last MAJOR release version (e.g., keep `1.0.0` when releasing `1.1.0` or `1.0.1`).
### Compatibility Suppressions
When intentional breaking changes are confirmed, create or update `CompatibilitySuppressions.xml` in the affected project directory. The repo already uses this pattern — see `src/ModelContextProtocol.Core/CompatibilitySuppressions.xml` for examples.
```xml
<?xml version="1.0" encoding="utf-8"?>
<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:ModelContextProtocol.SomeType.SomeMethod(System.String)</Target>
<Left>lib/net10.0/ModelContextProtocol.Core.dll</Left>
<Right>lib/net10.0/ModelContextProtocol.Core.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
</Suppressions>
```
The exact suppression entries are generated by the pack command when it reports errors — copy the suggested suppression XML from the build output. Remember that suppressions are needed **per target framework** (net10.0, net9.0, net8.0, netstandard2.0).
### Common Diagnostic IDs
| ID | Meaning |
|----|---------|
| CP0001 | Type or member exists in left but not in right (removed) |
| CP0002 | Member signature changed |
| CP0005 | Virtual member removed from unsealed type |
| CP0006 | Parameter or return type changed |
| CP0008 | Sealed type was previously unsealed |
See the [full diagnostic list](https://learn.microsoft.com/dotnet/fundamentals/package-validation/diagnostic-ids) for details.
## API Diff Report (ApiDiff)
The API diff report provides a human-readable summary of public API changes between the previous release and the new version. This is included in the release PR description alongside the ApiCompat results.
> **Important:** If the ApiDiff tool cannot be installed or fails to produce output, the release preparation process must **pause**. Do not fall back to a manual summary. Instead, present the error to the user and ask how to proceed. The user may choose to troubleshoot the tool, skip the API diff section, or abort the release preparation.
### Installing Microsoft.DotNet.ApiDiff.Tool
The `Microsoft.DotNet.ApiDiff.Tool` is published on the .NET **transport feed**, not on NuGet.org. The transport feed URL follows the pattern `https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet{MAJOR}-transport/nuget/v3/index.json`, where `{MAJOR}` is the major version of the .NET SDK from `global.json`.
1. **Determine the SDK major version** from `global.json`:
```sh
# Read the SDK version — e.g. "10.0.100" → MAJOR is 10
cat global.json
```
2. **Install the tool** globally with the `--prerelease` flag (required since the tool is only published as prerelease):
```sh
dotnet tool install --global Microsoft.DotNet.ApiDiff.Tool \
--prerelease \
--add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet{MAJOR}-transport/nuget/v3/index.json
```
For example, with .NET SDK 10.x:
```sh
dotnet tool install --global Microsoft.DotNet.ApiDiff.Tool \
--prerelease \
--add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet10-transport/nuget/v3/index.json
```
3. **Verify installation**:
```sh
dotnet apidiff --help
```
If the tool is already installed, update it with `dotnet tool update` using the same flags.
> **Reference:** The dotnet/core repo's [RunApiDiff.md](https://github.com/dotnet/core/blob/main/release-notes/RunApiDiff.md) documents this same tool and transport feed approach for generating API diff reports between .NET releases.
### Generating the API Diff
1. **Build the current version** in Release configuration:
```sh
dotnet build -c Release
```
2. **Download the baseline packages** from NuGet:
```sh
mkdir api-diff-temp && cd api-diff-temp
dotnet new console
dotnet add package ModelContextProtocol.Core --version {baseline-version}
dotnet add package ModelContextProtocol --version {baseline-version}
dotnet add package ModelContextProtocol.AspNetCore --version {baseline-version}
dotnet restore
```
3. **Run the diff** for each package, comparing the baseline assembly against the current build. Use `dotnet apidiff` with `-l` (left/baseline) and `-r` (right/current):
```sh
# ModelContextProtocol.Core
dotnet apidiff \
-l ~/.nuget/packages/modelcontextprotocol.core/{baseline-version}/lib/net10.0/ModelContextProtocol.Core.dll \
-r ../artifacts/bin/ModelContextProtocol.Core/Release/net10.0/ModelContextProtocol.Core.dll
# ModelContextProtocol
dotnet apidiff \
-l ~/.nuget/packages/modelcontextprotocol/{baseline-version}/lib/net10.0/ModelContextProtocol.dll \
-r ../artifacts/bin/ModelContextProtocol/Release/net10.0/ModelContextProtocol.dll
# ModelContextProtocol.AspNetCore
dotnet apidiff \
-l ~/.nuget/packages/modelcontextprotocol.aspnetcore/{baseline-version}/lib/net10.0/ModelContextProtocol.AspNetCore.dll \
-r ../artifacts/bin/ModelContextProtocol.AspNetCore/Release/net10.0/ModelContextProtocol.AspNetCore.dll
```
> **Note:** The exact CLI flags may vary by version. Run `dotnet apidiff --help` to confirm the available options. If the tool uses different argument names (e.g., `--left`/`--right`, `--before`/`--after`, or positional arguments), adapt accordingly.
4. **Capture the output** for each package and format as markdown fenced code blocks with `diff` syntax highlighting.
5. **Repeat for other target frameworks** if a more comprehensive report is desired (e.g., `net9.0`, `net8.0`, `netstandard2.0`). At minimum, diff the highest TFM (`net10.0`).
### Per-Package Reports
Generate separate reports for each SDK package:
- **ModelContextProtocol.Core** — the core library with minimal dependencies
- **ModelContextProtocol** — the main package with hosting and DI extensions
- **ModelContextProtocol.AspNetCore** — HTTP-based server implementations
### Cleanup
After generating the reports, delete any temporary files (downloaded baseline packages, generated API files, temp projects). These must not be committed.
## Presenting Results
### In the PR Description
Include both reports in the PR description under dedicated sections:
```markdown
---
## API Compatibility Report
✅ All packages pass API compatibility validation against v{baseline-version}.
_or_
⚠️ API compatibility issues detected (suppressions added for intentional breaks):
[Detailed ApiCompat output]
## API Diff Report
### ModelContextProtocol.Core
[Diff or table of changes]
### ModelContextProtocol
[Diff or table of changes]
### ModelContextProtocol.AspNetCore
[Diff or table of changes]
```
### In the User Summary (Step 11)
Present a condensed version for the user review:
- **ApiCompat**: pass/fail with count of issues and suppressions per package
- **ApiDiff**: count of additions, removals, and changes per package
```
API Compatibility: ✅ All 3 packages pass (2 existing suppressions in Core)
API Diff: +12 additions, -2 removals, ~3 changes across all packages
```

116
.github/skills/prepare-release/references/categorization.md vendored Normal file
View file

@ -0,0 +1,116 @@
# Categorization Guide
## Category Definitions
### What's Changed
Feature work, bug fixes, API improvements, performance enhancements, and any other user-facing changes. This includes:
- New API surface area (new types, methods, properties)
- Bug fixes that affect runtime behavior
- Performance improvements
- Breaking changes (these appear in both "Breaking Changes" and "What's Changed")
- Changes that span code + docs (categorize based on the primary intent)
### Documentation Updates
PRs whose **sole purpose** is documentation. Examples:
- Fixing typos in docs
- Adding or improving XML doc comments (when not part of a functional change)
- Updating conceptual documentation (e.g., files in `docs/`)
- README updates
- Adding CONTRIBUTING.md or similar guides
**Important**: A PR that changes code AND updates docs should go in "What's Changed" — only pure documentation PRs belong here. However, documentation PRs should still be studied during the breaking change audit, as they may document changes that were not properly flagged as breaking.
### Repository Infrastructure Updates
PRs that maintain the development environment but don't affect the shipped product or test coverage. Examples:
- Version bumps (`Bump version to X.Y.Z`)
- CI/CD workflow changes (GitHub Actions updates)
- Dependency updates from Dependabot
- Build system changes
- Dev container or codespace configuration
- Copilot instructions updates
- NuGet/package configuration changes
**Important**: PRs that touch the `tests/` folder should never be categorized as Infrastructure — they belong in either "Test Improvements" or "What's Changed" depending on whether product code was also modified.
### Test Improvements
PRs focused on test quality, coverage, or reliability. Examples:
- Adding new tests (unit, integration, regression, conformance)
- Fixing broken or incorrect tests
- Addressing flaky tests (timing, race conditions)
- Unskipping or skipping tests
- Test infrastructure improvements (new test helpers, test base classes)
**Important**: PRs that reference "MCP conformance tests" are not automatically test-only. Examine the PR body and file changes to determine whether product code was modified to achieve conformance — if so, the PR belongs in "What's Changed." Conformance PRs should never be placed in "Repository Infrastructure Updates."
## Entry Format
Use this simplified format (GitHub auto-links `#PR` and `@user`):
```
* Description #PR by @author
```
For PRs with co-authors (harvested from `Co-authored-by` commit trailers):
```
* Description #PR by @author (co-authored by @user1 @user2)
```
For Dependabot PRs, do not acknowledge @dependabot[bot]:
```
* Bump actions/checkout from 5.0.0 to 6.0.0 #1234
```
For direct commits without an associated PR (e.g., version bumps merged directly to the branch), use the commit description and `by @author` but omit the `#PR` reference:
```
* Bump version to v0.1.0-preview.12 by @halter73
```
For Copilot-authored PRs, identify who triggered Copilot using the `copilot_work_started` timeline event on the PR. That person becomes the primary author, and @Copilot becomes a co-author:
```
* Add trace-level logging for JSON-RPC payloads #1234 by @halter73 (co-authored by @Copilot)
```
## Sorting
Sort entries within each section by **merge date** (chronological order, oldest first).
## Examples from Past Releases
### What's Changed (format example)
```
* Add Trace-level logging for JSON-RPC payloads in transports #1191 by @halter73 (co-authored by @Copilot)
* Use Process.Kill(entireProcessTree: true) on .NET for faster process termination #1187 by @stephentoub
* Include response body in HttpRequestException for transport client errors #1193 by @halter73 (co-authored by @Copilot)
* Fix race condition in SSE GET request initialization #1212 by @stephentoub
* Fix keyset pagination with monotonic UUIDv7-like task IDs #1215 by @halter73 (co-authored by @Copilot)
* Add ILoggerFactory to StreamableHttpServerTransport #1213 by @halter73 (co-authored by @Copilot)
* Add support for message-level filters to McpServer #1207 by @halter73
* Add `DistributedCacheEventStreamStore` #1136 by @MackinnonBuck
```
### Documentation Updates (format example)
```
* Fix typo in elicitation.md #1186 by @ruyut
* Fix typo in progress.md #1189 by @ruyut
* Clarify McpMetaAttribute documentation scope #1242 by @stephentoub (co-authored by @Copilot)
```
### Repository Infrastructure Updates (format example)
```
* Bump version to 0.8.0-preview.1 #1181 by @stephentoub (co-authored by @Copilot)
* Bump actions/checkout from 6.0.1 to 6.0.2 #1173
* Bump the opentelemetry-testing group with 6 updates #1174
```
### Test Improvements (format example)
```
* Remove 10 second wait from docker tests #1188 by @stephentoub
* Fix Session_TracksActivities test #1200 by @stephentoub
* Add serialization roundtrip tests for all Protocol namespace types #1289 by @stephentoub (co-authored by @Copilot)
```
### Acknowledgements (format example)
```
* @ruyut made their first contribution in #1186
* @user submitted issue #1234 (resolved by #5678)
* @user1 @user2 @user3 reviewed pull requests
```

143
.github/skills/prepare-release/references/readme-snippets.md vendored Normal file
View file

@ -0,0 +1,143 @@
# README Code Sample Validation
This reference describes how to validate that C# code samples in README files compile against the current SDK.
## Which READMEs to Validate
Validate code samples from the **package README** files — these are shipped with NuGet packages and are the primary documentation users see:
| README | Package |
|--------|---------|
| `README.md` (root) | ModelContextProtocol |
| `src/ModelContextProtocol.Core/README.md` | ModelContextProtocol.Core |
| `src/ModelContextProtocol.AspNetCore/README.md` | ModelContextProtocol.AspNetCore |
Sample README files (`samples/*/README.md`) are excluded — the samples themselves are buildable projects and are validated by CI.
## What to Extract
Extract only fenced code blocks tagged as `csharp` (` ```csharp `). Skip blocks tagged as plain ` ``` ` (shell commands, install instructions) or any other language.
### Handling Incomplete Snippets
README samples are often **incomplete** — they use `...` for placeholder values, omit `using` directives, or show only a method body. The validation wrapper must account for this:
- **Placeholder expressions** like `IChatClient chatClient = ...;` — replace `...` on the right-hand side of assignments with `null!`
- **Missing usings** — the wrapper file supplies all common namespaces (see template below)
- **Top-level statements** — wrap in an `async Task` method so `await` works
- **Suppressed warnings** — disable CS1998 (async without await), CS8321 (unused local function), and similar non-substantive warnings
### Snippets That Cannot Be Validated
Some code blocks are illustrative fragments that cannot compile even with wrappers (e.g., partial class definitions shown in isolation, pseudo-code). If a snippet fails to compile after applying the standard fixups, examine the error:
- **API mismatch** (missing member, wrong type, wrong signature) → this is a **real bug** in the README that must be reported and fixed
- **Structural issue** (missing context, incomplete fragment) → exclude this specific snippet from validation with a comment explaining why
## Test Project Approach
Create a **temporary** test project that references the SDK projects, wraps each README's code samples in compilable methods, and builds.
### Project File Template
```xml
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<OutputType>Library</OutputType>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<LangVersion>preview</LangVersion>
<NoWarn>CS1998;CS8321;CS0168;CS0219;CS1591;CS8602</NoWarn>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\..\src\ModelContextProtocol\ModelContextProtocol.csproj" />
<ProjectReference Include="..\..\src\ModelContextProtocol.AspNetCore\ModelContextProtocol.AspNetCore.csproj" />
</ItemGroup>
</Project>
```
Place the project at `tests/ReadmeSnippetValidation/ReadmeSnippetValidation.csproj`.
### Source File Template
Create one `.cs` file per README. Each file wraps the README's code blocks in static methods inside a class. Use this pattern:
```csharp
#pragma warning disable CS1998
#pragma warning disable CS8321
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.AI;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using ModelContextProtocol;
using ModelContextProtocol.Client;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;
using System.ComponentModel;
using System.Text.Json;
namespace ReadmeSnippetValidation;
public static class RootReadmeSamples
{
// Snippet 1: Client example
public static async Task ClientExample()
{
// ... pasted snippet code ...
}
// Snippet 2: Server example
public static async Task ServerExample()
{
// ... pasted snippet code ...
}
// Snippet with attributed types (tools, prompts) go as nested or sibling types
[McpServerToolType]
public static class EchoTool
{
[McpServerTool, Description("Echoes the message back to the client.")]
public static string Echo(string message) => $"hello {message}";
}
}
```
### Build Commands
```sh
# Restore and build the validation project
dotnet restore tests/ReadmeSnippetValidation/ReadmeSnippetValidation.csproj
dotnet build tests/ReadmeSnippetValidation/ReadmeSnippetValidation.csproj
### Cleanup
After validation, **always delete** the `tests/ReadmeSnippetValidation/` directory. It must not be committed.
## Reporting Results
### All Snippets Compile
Report success and move to the next step:
> ✅ All README code samples compile successfully against the current SDK.
### Compilation Failures
For each failure:
1. Identify the README file and which code block failed
2. Show the compiler error
3. Classify the error:
- **API mismatch**: The README uses an API that doesn't exist or has a different signature. This indicates the README is outdated and needs updating.
- **Structural**: The snippet is a fragment that can't be wrapped. Note it for exclusion.
4. For API mismatches, investigate the correct current API and propose a fix
5. Present all findings to the user for confirmation before making any README edits
### Fixing Issues
If the user approves fixes:
1. Edit the README files directly with minimal, surgical changes
2. Re-run the validation build to confirm fixes compile
3. Ensure the overall solution still builds: `dotnet build`
4. Include the README fixes in the same release or as a prerequisite PR — the user decides