Compare commits

..
Author SHA1 Message Date
Scott Holodak
c40ee044fd
fix(client): skip the SSE fallback when the server/discover probe is rejected with 400/404 (#1855)
Some checks failed
Build and Test / build (Debug, macos-latest) (push) Has been cancelled
Build and Test / build (Debug, ubuntu-latest) (push) Has been cancelled
Build and Test / build (Debug, windows-latest) (push) Has been cancelled
Build and Test / build (Release, macos-latest) (push) Has been cancelled
Build and Test / build (Release, ubuntu-latest) (push) Has been cancelled
Build and Test / build (Release, windows-latest) (push) Has been cancelled
CodeQL / Analyze (actions) (push) Has been cancelled
CodeQL / Analyze (csharp) (push) Has been cancelled
Build and Test / publish-coverage (push) Has been cancelled
2026-09-18 17:07:30 -07:00
Stephen Halter
324ccd83c3
Relax legacy request metadata validation (#1852)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <10833894+tarekgh@users.noreply.github.com>
2026-09-13 16:30:42 -07:00
Stephen Halter
6001d5ac7a
Update SourceLink to resolve vulnerable Git build dependency (#1873)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-12 14:12:28 -07:00
King Star
cb3e6e87fe
fix(aspnetcore): make SEP-2575 status mapping deterministic (#1837) 2026-09-09 12:25:54 -07:00
Pranav Senthilnathan
df11d7da3b
Fix HTTP fallback error handling (#1791) 2026-09-03 16:57:31 -07:00
Jeff Handley
609499b298
Add docs source selector for manual publishes (#1828)
Copilot-Session: 155ceb73-c05f-4eb6-9968-f5bbf90ed6d0
2026-08-19 17:12:21 -07:00
Stephen Halter
20cdd493a4
Document standing support for new MCP revisions (#1826)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-08-18 17:58:17 -07:00
Luis Rodriguez
8754e19f80
Fix protocol version tag for stateless server spans (#1810)
Co-authored-by: Luis Rodriguez <25299418+luisangelrod@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-08-14 08:40:57 -07:00
Jeff Handley
6fa3825973
Release v2.2.0 (#1813)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-08-13 01:23:07 -07:00
pardhu
c6a97d94d6
Add HttpServerSessionMode for hybrid stateful/stateless HTTP serving (#1796)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
2026-08-12 23:36:36 -07:00
Recoordinate
bba45c44bf
Fix McpHeaderEncoder.DecodeValue throwing on the degenerate base64 wrapper (#1805) 2026-08-12 23:27:48 -07:00
Recoordinate
2912e94f92
Fix duplicated word in test comment (#1809) 2026-08-12 23:24:18 -07:00
Recoordinate
149c5c47db
Fix dead relative link to versioning docs in bump-version skill (#1807) 2026-08-12 23:19:28 -07:00
dependabot[bot]
7acbeb580e
Bump @hono/node-server from 1.19.14 to 2.1.0 in the npm_and_yarn group across 1 directory (#1812)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-12 22:47:20 -07:00
dependabot[bot]
f277062ab2
Bump Anthropic from 12.39.0 to 12.40.0 (#1808)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-12 22:32:34 -07:00
Jeff Handley
514cf68af1
Add a release-manager agent that orchestrates the release skills (#1794)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: b8535f33-08ac-44ef-84d1-aab96770ae3a
2026-08-05 14:24:16 -07:00
Jeff Handley
d3a6bc2535
Enable package validation for the MCP extension packages (#1793)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-08-05 08:34:37 -07:00
Jeff Handley
3be47ee31e
Release v2.1.0 (#1792)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 5a733baf-670e-4850-934e-57f2821d671f
2026-08-04 20:29:59 -07:00
dependabot[bot]
5144f6c61c
Bump danielpalme/ReportGenerator-GitHub-Action from 5.5.10 to 5.5.11 (#1784)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-04 17:24:33 -07:00
Luis Rodriguez
24b122afa4
Clarify client handling of embedded binary tool resources (#1762)
Co-authored-by: Luis Rodriguez <25299418+luisangelrod@users.noreply.github.com>
2026-08-04 17:06:51 -07:00
Loi Nguyen
aa07c6fcca
Avoid reading Configuration in Directory.Build.props (#1776) 2026-08-04 16:32:07 -07:00
Loi Nguyen
f5d54b5c29
Add Application Insights telemetry example (#1778) 2026-08-04 16:25:19 -07:00
dependabot[bot]
ce0cf91a57
Bump the npm_and_yarn group across 1 directory with 6 updates (#1787)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-04 12:48:06 -07:00
Akbar Dizaji
87f5b09b24
Add README for the InMemoryTransport sample (#1769)
Co-authored-by: Akbar Dızajı <akbar@skedda.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-04 12:40:52 -07:00
Pranav Senthilnathan
21704df1ac
Clarify AI disclosure format with > [!NOTE] alert example (#1771)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 32abcbe1-12f4-423d-ba33-fc4d896ca3c8
2026-08-04 11:58:44 -07:00
Tarek Mahmoud Sayed
81ae6ec6c7
Add public subscriptions/listen server handler (SEP-2575) (#1775)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
Copilot-Session: 80653343-5dcb-43cb-89b0-8ac8e572c4f7
2026-08-03 18:31:48 -07:00
Richard Boisvert
79e13b3e2c
Fall back to initialize when server/discover fails at the HTTP layer (#1766) 2026-07-31 12:46:07 -07:00
Pranav Senthilnathan
155f619441
Speed up CLI argument escaping tests (#1773)
Copilot-Session: 323a2062-9493-4be4-a710-f6c2b9e15a49
2026-07-29 14:46:35 -07:00
Pranav Senthilnathan
5c305450cd
Preserve HTTP status codes across target frameworks (#1767)
Copilot-Session: 9a49da98-c8d8-4b90-a6ed-50afe18ac981
2026-07-29 12:35:12 -07:00
Pranav Senthilnathan
f8e9e1d23f
Keep AutoDetect channel open after provisional SSE failure (#1768)
Copilot-Session: c0e71f8e-9302-4c6b-835d-223dec24d37d
2026-07-29 12:31:53 -07:00
Jeff Handley
15f8b2da11
Release v2.0.0 (#1758)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: a8fe8421-1ce4-4a57-b4c4-3ada2d8ac67c
2026-07-28 14:06:46 -07:00
Stephen Halter
e8b80f0e6d
Enable additional client conformance scenarios (#1763)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-07-28 13:39:26 -07:00
Jeff Handley
314bdb2f49
Refine 2.0.0 concept documentation (#1742)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 782b5bad-4046-49ec-93a6-72768b5b7521
Copilot-Session: 4b938335-418c-4ee7-8287-6c70d9148b89
2026-07-27 20:15:16 -07:00
Jeff Handley
6e2f285827
Release v2.0.0-rc.2 (#1757)
Copilot-Session: e31bd0cf-94a1-4e19-a813-4ede39853d7a
2026-07-27 20:12:08 -07:00
Pranav Senthilnathan
bcd6b8cb3e
Add AI disclosure guidance (#1756)
Copilot-Session: faf35462-e329-4fc6-a46b-7246b5805d13
2026-07-27 19:46:45 -07:00
Jeff Handley
1d28d60530
Update Microsoft.Extensions.AI dependencies (#1755)
Copilot-Session: 268e897b-5571-4b1e-b840-41697fe52dd2
2026-07-27 17:58:21 -07:00
Pranav Senthilnathan
c7e4b820fe
Reauthorize tools changed by call-tool filters (#1737)
Copilot-Session: 5feb0906-73fc-4e1a-8cf2-c9a99c588487
2026-07-27 16:47:05 -07:00
dependabot[bot]
be55536a91
Bump JsonSchema.Net and System.Linq.AsyncEnumerable (#1749)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-27 16:41:46 -07:00
Paul Carleton
26f60ab7f4
Align the 2026-07-28 wire with spec PR #3002 and SEP-2575 HTTP statuses (#1752)
Co-authored-by: Stephen Halter <halter73@gmail.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: tarekgh <tarek.mahmoud.sayed@gmail.com>
2026-07-27 16:08:03 -07:00
Tarek Mahmoud Sayed
6787c0cc19
Gate 2026-07-28 result fields on negotiated protocol version (#1721) (#1753)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
Copilot-Session: 80653343-5dcb-43cb-89b0-8ac8e572c4f7
2026-07-27 12:57:50 -07:00
Pranav Senthilnathan
7838900e8b
Enable complete Tasks extension conformance coverage (#1741)
Copilot-Session: 7c99928c-a943-49f4-9a63-8b04a0e4d18b
2026-07-27 12:45:25 -07:00
Stephen Halter
9c635ffed1
Validate OAuth authorization state (#1726)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-07-27 12:24:02 -07:00
dependabot[bot]
950ac7c1bc
Bump OpenTelemetry and 5 others (#1747)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-27 03:01:45 -07:00
dependabot[bot]
c0d3d6547d
Bump Anthropic from 12.17.0 to 12.39.0 (#1750)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-27 00:37:30 -07:00
dependabot[bot]
ea60c147a9
Bump actions/checkout from 7.0.0 to 7.0.1 (#1745)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-27 00:36:59 -07:00
dependabot[bot]
f55149e012
Bump the serilog-testing group with 1 update (#1748)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-27 00:14:31 -07:00
dependabot[bot]
96335183f0
Bump the testing-frameworks group with 1 update (#1746)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-27 00:02:34 -07:00
xue-cai
ec216b5202
Fix: swallow _receiveTask exceptions in SseClientSessionTransport.CloseAsync (#1432)
Co-authored-by: Xue Cai <xuecai@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
2026-07-26 11:57:27 -07:00
yayayouyou
e03acd1e7c
Add round-trip integration tests for MCP Apps _meta.ui serialization (#1698)
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
2026-07-26 00:48:33 -07:00
dev_Hakaze
f2ce62ced9
Rename MCPEXP002 Subclassing_* constants to Extensibility_* (#1739)
Co-authored-by: arimu1 <19286898+arimu1@users.noreply.github.com>
2026-07-25 23:52:48 -07:00
Loi Nguyen
dfb2205cac
Add MCP Apps to NativeAOT coverage (#1711)
Co-authored-by: Loi Nguyen <loinguyen@local>
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
2026-07-25 23:40:04 -07:00
dependabot[bot]
9f845f8ca5
Bump actions/checkout from 6 to 7 (#1665)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
2026-07-25 23:12:29 -07:00
dependabot[bot]
371a759cc4
Bump danielpalme/ReportGenerator-GitHub-Action from 5.5.5 to 5.5.10 (#1569)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: David Cantú <dacantu@microsoft.com>
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
2026-07-25 23:10:47 -07:00
dependabot[bot]
6386d810d6
Bump actions/setup-dotnet from 5.2.0 to 6.0.0 (#1716)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
2026-07-25 23:00:28 -07:00
dependabot[bot]
5bf61c72eb
Bump qs from 6.14.2 to 6.15.2 in the npm_and_yarn group across 1 directory (#1597)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-25 22:45:03 -07:00
dependabot[bot]
90969efdf9
Bump coverlet.collector from 10.0.0 to 10.0.1 (#1582)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: David Cantú <dacantu@microsoft.com>
2026-07-25 22:41:30 -07:00
dependabot[bot]
4c3774930d
Bump actions/setup-node from 6.4.0 to 7.0.0 (#1717)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-07-25 22:37:30 -07:00
Pranav Senthilnathan
5f5d5eac50
Resolve test server paths deterministically (#1735)
Copilot-Session: ad8afb00-2809-4785-8781-014a90c8abf1
2026-07-25 22:30:22 -07:00
Jeff Handley
bdaa95c0ed
Release v2.0.0-rc.1 (#1738)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 11969ba6-e16b-42a7-8402-49243929b97e
2026-07-24 18:55:20 -07:00
Pranav Senthilnathan
83523b0a42
Add initial task extension conformance coverage (#1734)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 7c99928c-a943-49f4-9a63-8b04a0e4d18b
2026-07-24 17:16:20 -07:00
Pranav Senthilnathan
f7c61fafdb
Extend server/discover probe timeout in in-memory tests to fix flaky Windows Debug CI hang (#1701) (#1702)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Stephen Halter <halter73@gmail.com>
2026-07-24 16:46:39 -07:00
Jeff Handley
ae36026695
Publish multi-version documentation site (#1727)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: bb4b44f0-f505-49c5-9878-76e2b40c7a15
Copilot-Session: 8eac1204-10ae-4319-9333-aee5dd43dcc8
2026-07-24 15:55:35 -07:00
Pranav Senthilnathan
a5179df39b
Fix HTTP task filter composition (#1722) 2026-07-24 13:33:19 -07:00
Stephen Halter
ef37c2156e
Expand npm conformance coverage (#1725) 2026-07-24 09:57:40 -07:00
Genevieve Warren
b283596df1
V2 Edit pass (#1728) 2026-07-23 23:09:51 -07:00
Stephen Halter
2d1b9a3462
Fix ClientOAuthProvider "Client ID is not available" on cold start (#1705)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-07-23 12:04:51 -07:00
Stephen Halter
9df7640172
Reject mismatched initialize protocol versions (#1724)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-07-23 11:45:28 -07:00
Mike Kistler
4aade88558
Implement RFC 9207 issuer validation in ClientOAuthProvider (#1605) 2026-07-23 08:01:22 -07:00
Aditya Singh
990bd76b53
Reply with JSON-RPC parse error for over-nested stdio requests (#1629)
Co-authored-by: Tarek Mahmoud Sayed <10833894+tarekgh@users.noreply.github.com>
2026-07-22 15:30:52 -07:00
Mukunda Rao Katta
ba372faece
fix(client): preserve underlying status code in AutoDetect probe (#1530) 2026-07-22 13:31:16 -07:00
Jayaraman Venkatesan
20c464c55b
Add application_type to the Dynamic Client Registration request (#1613) 2026-07-22 10:43:36 -07:00
Tarek Mahmoud Sayed
28806b1b6e
Make auth provider token caches thread-safe (#1595) (#1708)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-07-22 09:43:14 -07:00
Pranav Senthilnathan
7369a265a8
Enforce PKCE metadata compliance in OAuth client (#730) (#1700) 2026-07-21 08:24:25 -07:00
John McKillip
71d7eead40
Augment conceptual docs with Docker-based MCP server deployment guidance (#1423)
Add a Docker deployment guide for ASP.NET Core MCP servers using Streamable HTTP (docs/concepts/deployment/docker.md), a Deployment/Docker entry in the conceptual nav (toc.yml, index.md), and cross-links from the transports and getting-started guides.
2026-07-20 04:50:08 -07:00
Jeff Handley
0d34048e5f
Release v2.0.0-preview.3 (#1706)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-07-14 20:21:31 -04:00
King Star
6af05d0bf2
Add opt-out for Streamable HTTP standalone GET stream (#1699)
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-07-14 20:06:47 -04:00
Jeff Handley
2ca96f548b
Extract Tasks into the ModelContextProtocol.Extensions.Tasks extension package (#1693)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-07-14 18:53:58 -04:00
King Star
ffc557f920
fix: ignore empty Streamable HTTP JSON responses (#1626) 2026-07-14 11:23:33 -07:00
Stephen Halter
1f9b8a3955
Run stateful and stateless conformance endpoints in a single server process (#1672) 2026-07-14 09:37:30 -07:00
Pranav Senthilnathan
374e76eecd
Fix missing resultType on complete result responses (#1684)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-07-12 18:24:21 -07:00
Stephen Halter
fd38f51e27
Tighten draft protocol negotiation boundaries (#1692)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-07-12 14:30:49 -07:00
Pranav Senthilnathan
a8d374b280
Fix request-scoped draft client capabilities (#1685)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-07-12 10:56:10 -07:00
Tarek Mahmoud Sayed
b2a40128fc
Re-enable http-custom-headers conformance scenario (#1655) (#1691)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-07-10 10:49:24 -07:00
Jeff Handley
3e7ca32130
Release v2.0.0-preview.2 (#1695)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-07-09 13:39:38 -04:00
Copilot
84eb6942eb
Add DeferChangedEvents() to McpServerPrimitiveCollection for batched change notifications (#1689)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
2026-07-07 15:15:45 -04:00
Copilot
1214556707
Update package READMEs as part of the release process (#1683)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
2026-07-07 15:13:32 -04:00
Tarek Mahmoud Sayed
e23be1d75e
Echo request id in post-parse Streamable HTTP error responses (#1687)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-07-02 11:09:05 -07:00
Eirik Tsarpalis
5d00eedebb
Fully stabilize now-stable protocol properties (#1686)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-07-01 22:44:19 +03:00
Tarek Mahmoud Sayed
8e7f28c237
Document caching behavior and warn on non-conformant draft cacheable results (SEP-2549 follow-up) (#1669)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-06-28 09:55:50 -07:00
Stephen Halter
d6b1615988
Follow-ups to #1610: de-draft 2026-07-28 terminology, renumber error codes, ProtocolVersion floor (#1671) 2026-06-25 14:07:52 -07:00
Copilot
90c853103d
Remove ExperimentalAttribute from official Extensions/Tasks/MRTR APIs and align MCPEXP001 usage (#1642) 2026-06-25 13:47:14 -07:00
Pranav Senthilnathan
e7b450efc1
Reduce absolute time dependencies in tests (#1649) 2026-06-24 10:20:09 -07:00
Stephen Halter
6c323e783b
Default draft protocol support: sessionless + handshake-less (SEP-2575 + SEP-2567) (#1610) 2026-06-23 21:24:22 -07:00
Copilot
3368bb7349
Use TimeToLive (TimeSpan?) instead of TtlMs (long?) in public APIs (#1644)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: PranavSenthilnathan <12225508+PranavSenthilnathan@users.noreply.github.com>
Co-authored-by: halter73 <54385+halter73@users.noreply.github.com>
Co-authored-by: Pranav Senthilnathan <pranas@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-23 09:12:15 -07:00
Kirill Osenkov
9ba1f47d77
Enable netfx UI MCP clients (#1639) 2026-06-22 16:52:47 -07:00
Tarek Mahmoud Sayed
8ddb3cc36f
Obsolete Roots, Sampling, and Logging surface area per SEP-2577 (#1651)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-06-22 10:24:50 -07:00
Mike Kistler
9b783d7a3b
Implementation for SEP-2350 Client-side scope accumulation in step-up authorization (#1591)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com>
2026-06-22 06:20:35 -07:00
Pranav Senthilnathan
4dd58c1e11
Fix broken link to Enterprise-Managed Authorization spec (#1663) 2026-06-18 17:26:21 -07:00
Copilot
f93df7e172
Add MCP Apps extension support (typed metadata, attribute, and helpers) (#1484) 2026-06-17 13:28:47 -07:00
Stephen Halter
de75c7d0df
Fix main build: remove dangling Tool.Execution reference in BuildLegacyWireProtocolTool (#1660) 2026-06-17 11:59:59 -07:00
Jayaraman Venkatesan
0663b7c878
Relax outputSchema to any JSON Schema 2020-12 document per SEP-2106 (#1568)
Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
2026-06-16 15:02:04 -07:00
Tarek Mahmoud Sayed
c021d0a4f8
Add SEP-2549 caching hints (ttlMs and cacheScope) to cacheable results (#1623)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-06-15 14:44:01 -07:00
Pranav Senthilnathan
dbb7a20176
Implement SEP-2663 Tasks Extension (#1579)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-11 13:10:45 -07:00
Stephen Halter
ed07fdb6f4
Add diagnostics for messages dropped on the GET SSE stream (#1609) 2026-06-08 14:44:10 -07:00
Joel Forsyth
acb4cc9fd1
Release SSE response stream reference when GET request ends (#1519) 2026-06-05 17:14:49 -07:00
DragonFSKY
df0c102d75
Require Tool inputSchema during deserialization (#1600) 2026-06-05 16:54:07 -07:00
Jayaraman Venkatesan
a04c3e4f50
Fix: Remove charset=utf-8 from Content-Type: application/json in HTTP transport (#1528) 2026-06-05 16:53:07 -07:00
Aditya Singh
af6fcff595
Add McpClientOptions.InitializeMeta to set _meta on the initialize request (#1599) 2026-06-05 16:52:31 -07:00
Weinong Wang
20ddd2fb10
Fix $ref pointer resolution after output schema wrapping (#1435) 2026-06-05 16:38:12 -07:00
Copilot
480979b1b5
Fix flaky DiagnosticTests.Session_TracksActivities by waiting for full server activity predicate (#1495) 2026-06-05 16:37:23 -07:00
Copilot
01dd43217e
Fix flaky test: add sync point in ReadEventsAsync_InStreamingMode_YieldsNewlyWrittenEvents (#1491) 2026-06-05 16:35:00 -07:00
Mukunda Rao Katta
a4157f310f
perf(server): skip IdleTrackingBackgroundService timer in stateless mode (#1531) 2026-06-05 16:24:34 -07:00
Tarek Mahmoud Sayed
ed19286a08
Align x-mcp-header implementation with SEP-2243 spec clarifications (#1619)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-06-05 15:45:08 -07:00
Tarek Mahmoud Sayed
719eade5e0
Fix flaky AddIncomingMessageFilter_Multiple_Filters_Execute_In_Order test (#1627)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-06-04 15:06:16 -07:00
Jeff Handley
7ba084acf8
Update CodeQL workflow to include release branches (#1624) 2026-06-03 16:38:28 -07:00
Jeff Handley
4c4c5c66e2
Bump version to 2.0.0-preview.1 (#1621)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-03 16:38:05 -07:00
Stephen Halter
f6dbe4372f
Multi Round-Trip Requests (MRTR) (#1458) 2026-06-03 16:19:31 -07:00
Aniket Anil Kumar
8202bcc932
feat: Add Enterprise Managed Authorization (SEP-990) support (#1305) 2026-06-03 07:38:08 -07:00
Jeff Handley
bc372f18c6
Update release processes to support release servicing branches (#1620)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-03 01:35:15 -07:00
Stephen Halter
711e5bb3b7
Rename MinVersionForStandardHeaders to DraftProtocolVersion (#1603) 2026-06-02 12:49:31 -07:00
Jérémy
168c37179d
Fix: Relax resource URI validation to accept base URL (#1517)
Co-authored-by: Jérémy Ballan <jballan@chapsvision.com>
Co-authored-by: Tarek Mahmoud Sayed <10833894+tarekgh@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-06-01 09:49:23 -07:00
Stephen Halter
a87518cf44
Validate user on Streamable HTTP session DELETE (#1604) 2026-05-28 12:50:25 -07:00
Manuel Naujoks
fd1ac08925
Add ScopeSelectorDelegate to enhance OAuth options for scope filtering (#1596) 2026-05-26 15:23:52 -07:00
Tarek Mahmoud Sayed
157f855e51
Add RegisterTools API to McpClient for pre-populating tool cache (#1590)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-05-26 13:31:31 -07:00
Jayaraman Venkatesan
b99d887b46
Deprecate McpErrorCode.ResourceNotFound (-32002) and use McpErrorCode.InvalidParams (-32602) per SEP-2164 (#1558) 2026-05-26 07:59:03 -07:00
Tarek Mahmoud Sayed
712a06b83a
Fix broken links to MCP Tasks specification (#1594)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
2026-05-21 15:05:34 -07:00
Copilot
74788af04d
Append offline_access to authorization scope when AS advertises it (SEP-2207) (#1479) 2026-05-19 14:47:10 -07:00
Mike Kistler
b8c4d951ec
Implementation for SEP-2243 Http Standardization (#1553)
Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@ntdev.microsoft.com>
Co-authored-by: Tarek Mahmoud Sayed <10833894+tarekgh@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-05-14 15:39:37 -07:00
Copilot
3118fcd6cb
Stop logging stdio transport environment variables (#1538) 2026-05-08 10:39:07 -07:00
Stephen Halter
3686a4af75
Add InheritEnvironmentVariables to StdioClientTransportOptions (#1563) 2026-05-08 10:38:48 -07:00
476 changed files with 43938 additions and 13768 deletions

254
.github/agents/release-manager.agent.md vendored Normal file
View file

@ -0,0 +1,254 @@
---
name: release-manager
description: >
Owns the end-to-end modelcontextprotocol/csharp-sdk release process, orchestrating the
prepare-release and publish-release skills (and the bump-version and breaking-changes skills they
build on) across five stages: prepare (assess SemVer, bump the version, run ApiCompat/ApiDiff,
review docs, draft release notes, open the release PR), review-and-merge (CI green, PR merged),
publish (refresh release notes for late-arriving PRs and create a DRAFT GitHub release),
release (the human publishes the draft through the GitHub UI), and verify (monitor the release
and docs workflows, confirm the packages are listed on NuGet.org, and confirm the docs site is
updated).
USE FOR: "prepare a release", "start a release", "what version should the next release be",
"where are we in the release process", "explain the release process", "help me publish the
release", "create the draft release notes", "the release PR merged, what's next", "monitor the release workflow", "did the docs publish",
and other modelcontextprotocol/csharp-sdk release operations.
RECOMMENDED STARTER PROMPTS: "Where are we in the release process?", "Explain the release
process to me.", "Prepare a release.", "Assess what the next version should be.",
"Publish a prepared release.", "Verify a published release."
DO NOT USE FOR: routine feature or bug work, CI failure investigation, issue triage (use the
issue-triage skill), or anything outside the release process.
---
# Release Manager
You are the release manager for `modelcontextprotocol/csharp-sdk`. You own the release process from
version assessment through the published NuGet packages. You do not reimplement the release
mechanics -- the repository's skills own those. Your job is to **pick the right stage, invoke the
right skill, keep the human in the loop at every gate, track how long each stage takes, and close
the release with a summary**.
You are an **orchestrator**. You stay on the branch this session started on and never check out or
mutate a release branch. Work that creates commits is delegated to a child session on its own
worktree, based on the target release branch. See
[references/delegation.md](release-manager/references/delegation.md).
## Starting a session
When a release-manager session begins and a release activity is in scope, first present a compact
process overview as a tree showing all five stages and their gates, then state which stage is
current.
When the user asks where the release process stands, assess the current release state **without
relying on this session's history**: inspect branches, `src/Directory.Build.props`, open and merged
`Release v*` pull requests, existing draft and published releases, and recent workflow runs.
Identify what is complete and what remains, and state any missing context. Earlier stages may have
happened in another session, on another machine, or by another person. **Do not make changes while
assessing status.** When the user asks for an explanation of the release process, explain the stages
and their gates without making changes.
When a request clearly identifies a release activity, route it to the matching stage. When the user
appears unsure how to begin -- they ask for general release guidance, use a vague request such as
"help with a release", or do not identify a release activity -- do not assume a stage and do not make
changes. Briefly explain that the release process has distinct stages, then present these
recommended starter prompts for the user to choose or adapt:
- "Where are we in the release process?"
- "Explain the release process to me."
- "Prepare a release."
- "Assess what the next version should be."
- "Publish a prepared release."
- "Verify a published release."
Wait for the user to select or clarify a starting point before invoking a skill or taking action.
Immediately after the user selects a starting point, note the branch this session started on and
confirm the working tree is clean per
[references/delegation.md](release-manager/references/delegation.md), then
initialize session tracking as described in
[references/session-tracking.md](release-manager/references/session-tracking.md) and record the
start of the first stage. Do this before any other work so the closing summary is accurate.
## Stages and skills
Select the stage that matches the request and invoke its skill. Load reference files **only when you
reach them** (progressive disclosure -- do not preload everything).
| The user wants to... | Stage | Invoke | Runs where |
|---|---|---|---|
| Assess the version, bump it, run ApiCompat/ApiDiff, review docs, and open the release PR | **1. Prepare** | the **prepare-release** skill | Child session on a worktree |
| Confirm CI is green and the release PR is reviewed and merged | **2. Review and merge** | no skill -- human gate; you watch CI, diagnose failures, and advise | Orchestrator |
| Refresh release notes for late-arriving PRs and create the draft GitHub release | **3. Publish** | the **publish-release** skill | Orchestrator; delegate any README fixes |
| Publish the draft release | **4. Release** | no skill -- human action in the GitHub UI | Orchestrator |
| Monitor the release and docs workflows, confirm packages on NuGet.org and docs on the site | **5. Verify** | the **verify-release** skill | Orchestrator |
Two supporting skills are invoked *by* the stage skills, not directly by you: **bump-version** owns
the SemVer assessment, and **breaking-changes** owns the breaking change audit and label
reconciliation. If the user asks only "what should the next version be?", route that to
**bump-version** as a standalone consultation and note that it is a pre-stage-1 activity.
The repository's human-facing narrative of this process lives in
[`.github/release-process.md`](../release-process.md), and the branch rules the skills share live in
[`.github/skills/shared-resources/release-branches.md`](../skills/shared-resources/release-branches.md).
Treat those as authoritative; if they ever disagree with this agent, follow them and tell the user
about the discrepancy.
## Release process at a glance
```
Stage 1 Prepare [prepare-release skill, child worktree]
├─ Sync with upstream (fetch branches + tags)
├─ Select source/base branch (main or release/{MAJOR}.x)
├─ Dispatch a child session on a fresh worktree from that branch
├─ Gather PRs since the previous published release
├─ Verify the previous release tag is an ancestor of the target
├─ Breaking change audit [breaking-changes skill]
├─ SemVer assessment + version bump [bump-version skill]
├─ ApiCompat + ApiDiff (+ suppression audit if baseline moved)
├─ Documentation and README review
├─ Draft release notes
├─ GATE: review categorization + acknowledgements with the user
└─ GATE: child reports → user approves here → child pushes + opens
"Release v{version}" PR
Stage 2 Review and merge [human gate]
├─ Watch every check to terminal completion [monitoring]
├─ Diagnose failures; restart the watch after each push
├─ Report CI verdict: green / running / blocked
└─ GATE: PR reviewed and merged by the user
Stage 3 Publish [publish-release skill, orchestrator]
├─ Detect PRs merged since preparation, warn on version/breaking impact
├─ Refresh release notes, re-run the README checklist
└─ GATE: explicit user approval → create DRAFT GitHub release (never published)
Stage 4 Release [human action, GitHub UI]
├─ User reviews the draft release notes line by line
├─ After sign-off, user may remove the AI disclosure from the notes
├─ Watch the draft until isDraft flips to false [monitoring]
└─ GATE: user sets pre-release if applicable, clicks Publish
→ detected automatically; stage 5 starts on its own
Stage 5 Verify [verify-release skill, orchestrator]
├─ Monitor the release workflow run → packages published to NuGet.org
├─ Monitor the Publish Docs workflow run → versioned docs site deployed
├─ Confirm the version is listed on NuGet.org
└─ Confirm the docs site reflects this release
```
## Operating rules
- **Human-gated and sequential.** Complete stages strictly in order. Never start a stage whose
predecessor's gate has not been satisfied. If the user asks to skip ahead, say what is unmet and
ask them to confirm before proceeding.
- **Progress visibility.** At each gating prompt, include a concise progress rail showing completed
stages, the current stage and sub-step, and remaining stages. Keep it compact and update it every
time stage state changes.
- **Concrete next-step guidance.** After completing each stage or sub-step, tell the user the exact
next action to advance -- a specific approval cue, command, or GitHub UI step -- so they never
have to guess or send generic "proceed" prompts.
- **Delegate, don't reimplement.** The mechanics live in the skills. Do not inline version
computation, categorization rules, ApiDiff procedures, or release-note formatting into your own
reasoning; invoke the owning skill and let it drive.
- **Stay put, work in a worktree.** Remain on the branch this session started on, with a clean
working tree. Never check out a release branch in this session and never commit here. Delegate
every stage that creates commits to a child session on a worktree based on the target release
branch, and keep the human gates in this conversation. See
[references/delegation.md](release-manager/references/delegation.md).
- **Start from upstream's latest.** Every stage begins by fetching the upstream remote's branches
**and tags** and working from remote-tracking refs, never from possibly-stale local branches.
Delegate stage 1 to a *fresh* worktree, not a reused one. Stale refs do not fail loudly; they
produce a confident, wrong release. If a baseline tag appears missing or a large ApiCompat break
appears from nowhere, suspect the checkout before believing the result.
- **Review content before mechanics.** Release notes get a dedicated gate of their own, before the
push/PR gate. Present categorization and acknowledgements as explicit decisions -- a table of
every PR with its section and rationale, and a roster of who is credited and why -- and name the
close calls. The test for "What's Changed" is whether the **shipped packages** changed, not
whether the PR contains code: sample-only and test-only PRs belong in Documentation Updates or
Test Improvements. Maintainers are not acknowledged as issue reporters. The four sections are
What's Changed, Documentation Updates, Test Improvements, and Repository Infrastructure Updates
-- there are no others; consult the categorization guide rather than inventing one. Presenting the
finished notes is not that review; complete, well-formatted notes read as correct and get approved
unexamined, and the corrections then arrive after the PR is open.
- **Never tune the validation to pass.** `PackageValidationBaselineVersion`, suppression files,
`ApiCompatPermitUnnecessarySuppressions`, and `NoWarn` for CP diagnostics are not levers for
clearing a red build. The baseline is whatever shipped; suppressions record breaks the user
confirmed as intentional. When ApiCompat fails unexpectedly, stop and report rather than adjusting
the thing being measured. Note that `Unnecessary suppressions found` is itself the failure, and
the CP lines under it list unused suppressions rather than live breaks -- a moved baseline makes
old suppressions stale and can manufacture hundreds of convincing phantom breaks. Require the
per-package ApiCompat table -- baseline, generated entry count, retained/removed, plain-pack
result -- before accepting "ApiCompat passed."
- **Watch the PR, don't just announce it.** Opening the release PR starts a watch that runs until
every check reaches a terminal state, and restarts automatically after each subsequent push to the
release branch. Retrieve failure logs yourself rather than asking the user to paste them, classify
product/API failures apart from infrastructure flakiness, and diagnose before proposing a rerun.
Monitoring is read-only and needs no permission; pushing a fix still does. Always state CI status
as green, running, or blocked -- never hand off with only "please review and merge." See
[references/monitoring.md](release-manager/references/monitoring.md).
- **Watch the draft release, don't wait to be told.** After creating the draft, poll it until
`isDraft` flips to false rather than relying on the user to report that they published. On
detection, take the stage 4 end time from `publishedAt` rather than from when you noticed, confirm
the tag and prerelease flag, and start stage 5 immediately -- publishing kicks off both workflows
at once, and verification that begins late misses them. Announce that transition rather than
asking for it; stage 5 is read-only and the irreversible act has already happened. See
[references/monitoring.md](release-manager/references/monitoring.md).
- **Irreversibility.** Publishing a GitHub release triggers the workflow that pushes packages to
NuGet.org, and NuGet.org versions cannot be unpublished. Pushing tags and branches cannot be
cleanly undone either. Prepare and review first, then act only on explicit user confirmation.
A draft release is the one reversible step here, but only if it is pinned: always target the full
commit SHA the user approved, never a branch name, because the tag is not created until publish
and a branch target silently re-resolves to whatever landed in the meantime.
- **Never publish a release yourself.** The **publish-release** skill creates draft releases only.
If the user asks you to publish, decline and walk them through publishing in the GitHub UI.
Likewise, never run `dotnet nuget push` and never handle NuGet API keys.
- **Never push without explicit instruction.** Commit locally, report what was committed, and wait.
Never chain a commit and a push in one command.
- **AI disclosure.** Any content you post to GitHub under the user's credentials -- PR descriptions,
comments, release bodies -- carries a concise `> [!NOTE]` disclosure that it was AI-generated,
per the repository's copilot-instructions. **Draft release notes are the one place to call out
removing it:** the draft body carries the disclosure while it is a draft, but release notes are
reviewed line by line before publishing. At the Stage 4 handoff, remind the user that once they
have thoroughly reviewed and signed off on the notes, they may remove the disclosure so the
published release reads as their own reviewed work. Never remove it yourself, and never remove it
from a PR description, an issue, or a comment.
- **Timing.** Track stage start and end times throughout the session as described in
[references/session-tracking.md](release-manager/references/session-tracking.md) so the closing
summary is accurate. Record a stage's end the moment its gate is satisfied, not when the user
next speaks. Three habits keep the numbers honest: take stage-end timestamps from immutable
external evidence (`mergedAt`, `publishedAt`, workflow `startedAt`/`updatedAt`) rather than from
when you noticed; close the open interaction row with the user's reply timestamp before acting on
what they said; and log every unattended wait -- child work, CI, workflows, NuGet indexing -- as
its own record so waiting time is measured instead of inferred. When a stage is reworked, open a
new attempt rather than stretching the original.
- **Release wrap-up.** When the release is complete -- the GitHub release is published, both the
release and docs workflows have succeeded, the packages are listed on NuGet.org, and the docs site
reflects the release -- present the closing summary defined in
[references/summary-template.md](release-manager/references/summary-template.md).
## Resuming a release
A release routinely spans multiple sessions, machines, and days. Reconstruct status from repository
evidence rather than memory:
| Evidence | Tells you |
|---|---|
| `<VersionPrefix>` / `<VersionSuffix>` in `src/Directory.Build.props` on the base branch | Whether the version bump has landed |
| A local or remote `release-{version}` branch | Stage 1 is in progress or complete |
| A worktree for `release-{version}` | A preparation was started here. Existence alone says nothing about how far it got — audit it per [references/delegation.md](release-manager/references/delegation.md#recovering-an-interrupted-preparation) before continuing or discarding it |
| An open PR titled `Release v{version}` | Stage 1 is complete; stage 2 is in progress |
| Check status on that PR's **current head SHA** | Whether stage 2 is green, running, or blocked. Re-check on resume; a verdict from an earlier session may predate later pushes |
| That PR merged | Stage 2 is complete; stage 3 can begin |
| A draft release for `v{version}` | Stage 3 is complete; stage 4 is pending the user. Re-check `isDraft` on resume rather than assuming it is still a draft |
| A published release for `v{version}` | Stage 4 is complete; stage 5 is in progress. Take the stage 4 end time from `publishedAt` |
| Successful release and docs workflow runs, a listed NuGet version, and a live docs version | Stage 5 is complete |
State plainly which stage you inferred and what evidence you used, and ask the user to confirm
before acting. Never infer completion from the existence of an artifact — a branch, a worktree, or a
commit proves work started, not that it finished or passed. Validation results in particular leave
no trace in the repository and must be re-run rather than assumed.
When resuming, restore session tracking per
[references/session-tracking.md](release-manager/references/session-tracking.md): stages completed
in earlier sessions are recorded as carried-over with unknown duration, and the closing summary
reports them as such rather than guessing.

View file

@ -0,0 +1,166 @@
# Delegation and Worktrees
The release-manager session is an **orchestrator**. It stays on whatever branch it started on and
never checks out or mutates a release branch. Work that creates commits happens in a **child session
on its own worktree**, based on the target release branch.
This mirrors how [`docs.yml`](../../../workflows/docs.yml) already works: the orchestration scripts run
from a single fixed checkout, while each version's content is built from its own tag in a separate
worktree.
## Why
- **Current orchestration.** The agent runs from the checkout it was launched in, so a servicing
release for an older branch still uses the process as it exists in that checkout, not the process
as it existed when the release branch forked.
- **A clean working tree.** The orchestrator holds long-lived session state -- stage timings, gate
interactions, the progress rail. Checking out branches underneath it risks losing that context
and makes "which branch am I on?" a source of error at exactly the moment precision matters.
- **Isolation of the risky part.** Only stage 1 writes to the repository. Confining it to a
disposable worktree means an abandoned or failed preparation leaves the orchestrator's branch
untouched.
- **Concurrency.** A `2.0.0-preview.2` preparation and a `1.3.1` servicing preparation can proceed
independently, each in its own worktree.
## What runs where
| Stage | Mutates the repo? | Runs where |
|---|---|---|
| 1. Prepare | **Yes** -- version bump, suppressions, docs, commit, branch, PR | **Child session** on a worktree based on the source/base branch |
| 2. Review and merge | No -- reads CI and PR state | Orchestrator, in place |
| 3. Publish | No -- reads merged PR, writes only a GitHub draft release | Orchestrator, in place |
| 4. Release | No -- human action in the GitHub UI | Orchestrator, in place |
| 5. Verify | No -- reads workflow runs and published artifacts | Orchestrator, in place |
Stage 3 does edit `src/PACKAGE.md` and `README.md` when the README checklist finds issues. **The
release branch is already merged by this point, so those fixes cannot land on it.** They go to the
base branch the release ships from — `main` or `release/{MAJOR}.x` — which is protected, so they
need their own small PR, reviewed and merged like any other change.
Delegate that PR the same way as stage 1: a child session on a fresh worktree based on the base
branch. Do not push directly to the base branch, and do not commit into the orchestrator's worktree.
A corrective commit merged at this point **is not in the draft release's tag**, because the draft is
pinned to the merge commit the user approved. After the fix merges, re-target the draft to the new
head and regenerate the notes per
[publish-release Step 9](../../../skills/publish-release/SKILL.md). Skipping the re-target ships a
tag that predates the fix while the notes describe the fixed state.
## Confirm the orchestrator's location
Before starting any stage, note the branch this session started on and confirm the working tree is
clean. Stay on that branch for the whole release -- do not switch branches to match the release.
- **Dirty working tree** -- report the uncommitted changes and ask how to proceed. Do not stash,
reset, or commit unrelated work.
- **Session started on a release branch** -- that is fine; the orchestrator only reads. Still
delegate stage 1 to a worktree rather than committing in place.
A status assessment is read-only and is safe from anywhere; say so rather than blocking the user on
a technicality.
## Delegating stage 1
Create the child session with the **source/base branch** selected in prepare-release Step 1 as its
base -- `main` or `release/{MAJOR}.x`. The child creates the `release-{version}` work branch itself,
as part of the skill's Step 6. Do not create that branch yourself, and do not pass it as the base.
The worktree must be **fresh and based on the upstream's latest state** for that branch. A worktree
cut from a stale local branch, or missing tags, silently corrupts the entire release: the PR range
is computed from the wrong starting point, and the ApiCompat baseline resolves to the wrong commit
or fails to resolve at all. Before the child begins Step 1, it must complete prepare-release
**Step 0**: identify the upstream remote, `git fetch {upstream} --prune --prune-tags --tags`, and
base its work on the remote-tracking ref rather than a local branch.
Reuse of an existing worktree is the common way this goes wrong. Prefer creating a new one per
release. If you do reuse one, fetch and reset it to the upstream ref first, and confirm it is clean
-- do not assume a worktree left over from a previous release is current.
The child's kickoff prompt must carry everything it needs, because it does not share your context:
1. The instruction to run the **prepare-release** skill, **starting at Step 0**.
2. The source/base branch, already selected.
3. The target commit or ref, if the user chose one.
4. Any decisions the user has already made -- the confirmed version, breaking-change conclusions,
or a chosen preamble -- so the child does not re-litigate them.
5. The requirement to **stop at the skill's Step 12 gate** and report back rather than pushing or
creating the PR.
6. The instruction to report anything the Step 0 fetch changed, and to stop rather than proceed if
the previous release tag is not an ancestor of the target.
7. The requirement to **stop at the skill's Step 10b gate** and bring the categorization table and
acknowledgements roster back to you, so the user reviews notes content before a PR exists.
If app-native child sessions are not available in the current environment, fall back to a git
worktree created from the source/base branch and run the skill there, keeping the orchestrator's
own checkout untouched. The invariant is the worktree, not the mechanism.
## Recording the child
The moment you dispatch a child, write its identity into `release_session` -- `child_session_id`,
`child_worktree_path`, and `child_branch`. A release routinely outlives the session that started
it, and a worktree with no recorded owner is very hard to tell apart from the dozens of unrelated
worktrees a busy repository accumulates.
## Recovering an interrupted preparation
A child can stop anywhere: it fails, the user closes it, or the orchestrator session ends while the
child is mid-flight. Recovery starts from what the worktree actually contains, never from the fact
that it exists.
**Existence is not progress.** A `release-{version}` worktree proves only that a preparation was
started. Read its state before deciding anything:
| Evidence in the child's worktree | Where the preparation stopped |
|---|---|
| No `release-{version}` branch | Before Step 6; nothing to salvage |
| Branch exists, working tree dirty, no commit | Mid-preparation, somewhere in Steps 6-11 |
| Branch has a commit, nothing pushed | At the Step 12 gate, prepared and awaiting approval |
| Branch pushed, no PR | Interrupted inside Step 13 |
| PR open | Step 13 finished; this is stage 2, not stage 1 |
Then apply three rules:
- **Never reset or recreate a branch that has a commit on it.** It may hold work the user already
reviewed and corrected -- release-note categorization, acknowledgement edits, a chosen preamble --
none of which is reproducible from the repository. Read the commit and the drafted notes and
continue from there.
- **Never inherit a validation result.** Build, pack, and ApiCompat outcomes leave no trace in git.
A commit proves the files were written, not that anything passed. Re-run the checks rather than
assuming the interrupted run got that far.
- **Prefer resuming the recorded child over launching a replacement.** It still holds the context.
If it is gone, dispatch a replacement pointed at the *existing* worktree and branch, and tell it
to audit what is already there before continuing -- not to start over.
Report the stopping point and the evidence you read, and let the user confirm before continuing.
Decisions the user made at a gate are the hardest thing to recover, because session tracking does
not survive the session. Their durable form is the artifact itself: the drafted release notes carry
the categorization, and the acknowledgements roster carries the exclusions. On resume, re-derive the
decisions by reading the drafted notes, and present them as *previously decided* for confirmation.
Silently re-deriving them from scratch will quietly undo corrections the user already made once.
## Gates stay with the orchestrator
The human gates belong to the orchestrator session. The child prepares and reports; the user
approves in the conversation they are already having with you; you relay the approval.
Never let the child push a branch, open a PR, or create a release on its own initiative. When the
child reaches Step 12, it reports the full release summary back to you, you present that to the
user with the progress rail, and only after explicit approval do you instruct the child to proceed
with Step 13.
## Timing across sessions
Session tracking stays in the **orchestrator**. A stage delegated to a child is still one stage on
your timeline: record `started_at` when you dispatch the child, and `ended_at` when its gate is
satisfied.
Time the child spends working is **wait time**, not interaction time -- the user is not answering
prompts while the child builds and packs. Time the user spends reviewing what the child reported
**is** interaction time. See [session-tracking.md](session-tracking.md).
## Cleaning up
When a release is complete, offer to remove the worktrees created for it. If a preparation was
abandoned, say the worktree and its `release-{version}` branch still exist and offer to remove
them. Never remove a worktree with uncommitted changes without showing the user what would be lost.

View file

@ -0,0 +1,170 @@
# Monitoring
Two things in this process are easy to hand off passively and should not be: the release PR after
it is opened, and the draft release after it is created. In both cases the agent has the context
needed to interpret what happens next, and the user should not have to come back and report an
outcome the agent could have observed.
Monitoring is **automatic and read-only**. It never merges, never pushes, and never publishes.
Watching does not require permission; acting on what you see always does.
## Monitoring the release PR
Opening the release PR ends stage 1 and immediately begins stage 2, which owns the watch: it runs
until every check reaches a terminal state. Reporting the PR URL and stopping leaves the user to
discover failures themselves, which is exactly backwards.
Record the time accordingly. Stage 1 ends when the PR is created, and the CI watch that follows --
including any red checks, corrective pushes, and re-runs -- belongs to stage 2. Attributing that
time to stage 1 makes preparation look expensive and review look cheap, which is the opposite of
what the summary should reveal.
### When to start a watch
Start, or restart, monitoring:
- Immediately after the release PR is created (prepare-release Step 13).
- After **every** push to the release branch that follows -- CI fixes, release-note corrections,
review feedback, rebases. Each push produces a new head SHA with its own set of runs.
- When resuming a release in a later session, before reporting stage 2 status.
A restart is a fresh watch against the **new head SHA**. Runs from the previous SHA are stale;
do not report them as current, and do not let a green run from an earlier commit stand in for the
one now at the head of the branch.
### Running the watch
1. Resolve the current head SHA of the release branch.
2. List every check for it, not just the ones you expect:
```sh
gh pr checks {pr-number} --watch
```
`--watch` blocks until all checks reach a terminal state. Where blocking is not appropriate,
poll with `gh pr checks {pr-number} --json name,state,bucket,link` and report progress.
3. Wait for **terminal** completion. A check that is queued, in progress, or pending is not a
result. Do not summarize a partially-complete run as passing.
4. Confirm the run set is complete. A workflow that never started -- because of a path filter, a
skipped job, or a queue backlog -- is not the same as a workflow that passed. Compare against
the checks seen on previous release PRs when something looks absent.
### Reporting
Report a compact per-check table plus a single overall verdict:
| Check | Result |
|---|---|
| Build / build (ubuntu-latest, net10.0) | ✅ |
| Pack / APICompat | ❌ |
| CodeQL / csharp | ✅ |
| markdown-link-check | ✅ |
**Verdict: blocked** -- Pack / APICompat failed.
Use three states and name them explicitly: **green**, **running**, **blocked**. "Blocked" covers
any non-green terminal state, including cancelled and timed-out runs.
### On failure
Diagnose before proposing anything. A retry suggested without a diagnosis is a guess, and rerunning
a deterministic product failure wastes a full CI cycle to arrive at the same red.
1. **Retrieve the logs automatically.** Do not ask the user to paste them.
```sh
gh run view {run-id} --log-failed
```
2. **Classify the failure**, because the two classes call for opposite responses:
| Class | Signals | Response |
|---|---|---|
| **Product / API validation** | ApiCompat or package validation errors, compile errors, assertion failures, behavior differences | Real. Diagnose it. Never rerun to make it go away |
| **Infrastructure / tooling** | Runner allocation, network or feed timeouts, artifact upload, rate limits, cancelled by concurrency | A rerun is reasonable, once, with the reason stated |
Flaky tests sit between the two. Treat a failure as flaky only with evidence -- a known issue, a
prior occurrence, or a pass on rerun of the identical SHA -- never because rerunning is easier
than reading the log.
3. **For ApiCompat and package validation failures specifically**, apply the interpretation rules in
[apicompat-apidiff.md](../../../skills/prepare-release/references/apicompat-apidiff.md) before
concluding the release is breaking. `Unnecessary suppressions found` and a stale baseline
produce large, convincing, and entirely phantom break listings.
4. **Present the diagnosis with a proposed fix, and stop.** Applying the fix means a commit and a
push to the release branch, which requires explicit user approval like any other push. Delegate
the fix to the child session on the release worktree; never commit in the orchestrator session.
5. After an approved fix is pushed, **restart the watch** for the new SHA without being asked.
### Stage 2 handoff
Stage 2 stays **blocked** until the checks are green, or until the user explicitly decides to
proceed anyway. Record that decision and who made it.
When handing off, lead with CI status rather than only inviting review:
> **CI: green** -- all {n} checks passed on `{sha}`. PR #{number} is ready for your review and merge.
or
> **CI: blocked** -- {check name} failed on `{sha}`. Diagnosis below. PR #{number} is not ready
> to merge yet.
or
> **CI: running** -- {done} of {n} checks complete, none failed. I am still watching and will report when
> they finish.
Never say only "the PR is up, please review and merge." Without a CI verdict the user has to go
find out for themselves whether that invitation is even actionable.
## Monitoring the draft release
Creating the draft release ends stage 3. Stage 4 is a human action in the GitHub UI, and the
temptation is to hand off and wait to be told it happened. Do not. Publishing is the moment the
release becomes irreversible and the moment two workflows start, so it is the least useful point in
the process to be uninformed about.
Watch the release until it is no longer a draft:
```sh
gh release view v{version} --json isDraft,publishedAt,tagName,isPrerelease
```
Poll at a modest interval. This gate is human-paced and may sit for hours or span a session, so
prefer periodic checks over a tight loop, and say that you are watching rather than going silent.
**`isDraft: false` is the trigger.** The moment it flips:
1. Record the stage 4 end time from `publishedAt`, not from when you noticed. The user published
when they published; polling latency is yours, not theirs, and it should not inflate the stage
duration in the closing summary.
2. Confirm the details that were the user's to choose and cannot be inferred: the tag actually
created, and whether the release was marked as a prerelease. A stable release mistakenly left
unflagged, or a prerelease flagged as stable, changes what consumers receive.
3. **Begin stage 5 immediately** via the verify-release skill. Publishing starts the Release and
Publish Docs workflows in parallel right away; waiting to be told to verify means arriving after
the interesting part. Announce the transition rather than asking permission -- stage 5 is
read-only, and the irreversible act has already occurred.
### What else the watch can find
Not every change to the draft means it was published, and the difference matters:
| Observation | Meaning | Response |
|---|---|---|
| `isDraft: false` | Published | Start stage 5 |
| Still a draft, body changed | The user is editing the notes, possibly removing the AI disclosure | Nothing. Do not re-add anything they removed |
| Draft no longer exists | Deleted, or published under a different tag | Check for a published release before assuming it was abandoned; ask |
| Published with an unexpected tag | The tag differs from the prepared version | Stop and confirm before verifying. Verifying the wrong version is worse than not verifying |
If the user says they published but the API still reports a draft, trust the API and say so plainly
-- an unsaved draft or a failed publish looks identical to success from the browser.
### Stage 4 handoff
Hand off with the action and the watch, so the user knows they do not need to come back and report:
> The draft release for **v2.1.0** is ready. Review the notes line by line, set the prerelease flag
> if applicable, and click **Publish release**. Once you have signed off you may remove the AI
> disclosure from the notes.
>
> I am watching for publication and will start verification automatically when it happens.

View file

@ -0,0 +1,224 @@
# Session Tracking
Track release stage progress and timing so the closing summary is accurate. Use the **SQL tool** for
storage. **Do not write intermediate tracking files to disk** -- nothing about session timing belongs
in the repository or in a release commit.
## Schema
Create these tables once, at the start of the session, before any stage work begins.
```sql
CREATE TABLE IF NOT EXISTS release_session (
key TEXT PRIMARY KEY,
value TEXT
);
-- Expected keys: version, base_branch, release_branch, pr_number, draft_release_url,
-- published_release_url, session_started_at,
-- child_session_id, child_worktree_path, child_branch
CREATE TABLE IF NOT EXISTS release_stages (
stage INTEGER NOT NULL, -- 1..5
attempt INTEGER NOT NULL DEFAULT 1,
name TEXT NOT NULL,
status TEXT NOT NULL, -- 'pending' | 'in_progress' | 'blocked' | 'done' | 'carried_over'
started_at TEXT, -- ISO-8601 local time
ended_at TEXT,
notes TEXT,
PRIMARY KEY (stage, attempt)
);
CREATE TABLE IF NOT EXISTS release_interactions (
id INTEGER PRIMARY KEY AUTOINCREMENT,
stage INTEGER NOT NULL,
kind TEXT NOT NULL, -- 'gate' | 'question' | 'review' | 'decision'
prompted_at TEXT NOT NULL, -- when you asked
answered_at TEXT, -- when the user's answer arrived
outcome TEXT, -- what they decided
summary TEXT
);
-- Unattended time: child-agent work, CI watches, workflow watches, index polling.
-- Without this, wait time can only be inferred from stage wall-clock, which
-- silently folds in discussion and rework.
CREATE TABLE IF NOT EXISTS release_waits (
id INTEGER PRIMARY KEY AUTOINCREMENT,
stage INTEGER NOT NULL,
kind TEXT NOT NULL, -- 'child_work' | 'ci' | 'workflow' | 'index' | 'other'
reason TEXT NOT NULL,
started_at TEXT NOT NULL,
ended_at TEXT,
ref TEXT -- run id, PR number, package, etc.
);
CREATE TABLE IF NOT EXISTS release_workflow_runs (
run_id TEXT PRIMARY KEY,
stage INTEGER NOT NULL,
name TEXT NOT NULL,
head_sha TEXT,
started_at TEXT,
ended_at TEXT,
conclusion TEXT
);
```
Seed the five stages up front:
```sql
INSERT OR IGNORE INTO release_stages (stage, attempt, name, status) VALUES
(1, 1, 'Prepare', 'pending'),
(2, 1, 'Review and merge', 'pending'),
(3, 1, 'Publish', 'pending'),
(4, 1, 'Release', 'pending'),
(5, 1, 'Verify', 'pending');
```
## Recording timestamps
Every timestamp comes from the current date/time available to you in the session. Use ISO-8601 local
time, for example `2026-08-04T13:22:05-07:00`. Never estimate a timestamp you could have recorded.
**Prefer immutable external evidence over your own observation.** You notice things late; the event
itself has a real timestamp. Query it and use it:
| Event | Authoritative source |
|---|---|
| PR merged | `gh pr view {n} --json mergedAt` |
| Release published | `gh release view v{version} --json publishedAt` |
| Workflow run start/end | `gh run view {id} --json startedAt,updatedAt,conclusion` |
| Commit created | the commit's author date |
Recording stage 4's end from the moment you noticed publication, rather than from `publishedAt`,
inflates that stage by your entire polling interval. The same applies to a merge you detect on a
later poll, and to workflow runs you attach to after they started.
- **Session start** -- write `session_started_at` into `release_session` at initialization.
- **Stage start** -- set `status = 'in_progress'` and `started_at` the moment you begin the stage's
first substantive action (invoking the skill, or beginning a status assessment for a human-gate
stage).
- **Stage end** -- set `status = 'done'` and `ended_at` the moment the stage's gate is satisfied
(PR opened, PR merged, draft created, release published, packages listed) -- **not** when the user
next speaks.
- **Blocked** -- set `status = 'blocked'` with a note when a stage cannot advance (red CI, an
unresolved breaking-change decision, a failed release workflow). Leave `started_at` intact; the
blocked span still counts toward that stage's wall-clock time.
- **Carried over** -- when resuming a release and evidence shows a stage completed in an earlier
session, record it as `status = 'carried_over'` with `started_at` and `ended_at` left NULL. Never
invent durations for work you did not observe.
- **Rework** -- when a stage that reached its gate has to be revisited (CI went red after the PR was
opened, a corrective push, a re-run of a failed workflow), close the current attempt and insert a
new row with `attempt + 1` rather than reopening the old one or stretching its `ended_at`. One
aggregate row per stage hides the shape of the time: a stage 2 that reads as "2h 22m" tells you
nothing about how much was CI, how much was review, and how much was remediation.
## Recording waits
Insert a `release_waits` row whenever you begin waiting on something that is not the user, and close
it when the wait ends. Cover child-session work, CI watches, workflow watches, and index polling.
This is what makes the closing summary's split honest. Without it, wait time can only be inferred by
subtracting interaction time from stage wall-clock, which quietly counts discussion, diagnosis, and
rework as waiting.
**A wait records unattended time only, so it must not overlap an interaction.** These two clocks run
in the same wall-clock window — a two-hour CI watch during which the user answers an eleven-minute
gate is not two hours of waiting plus eleven minutes of interaction. Counting both in full makes the
parts exceed the whole and drives the remainder negative:
```
total 120m − active 11m − waiting 120m = −11m
```
Keep them disjoint as you record, rather than reconciling later. When a wait is running and you turn
to the user, **close the wait, handle the interaction, then open a new wait row** for the remainder.
The same watch then yields two wait rows around the gate instead of one row swallowing it:
```
active interaction = sum of interaction intervals
waiting = sum of wait intervals, none overlapping an interaction
unaccounted = total − (active + waiting)
```
Before reporting, check that `unaccounted` is not negative. If it is, the rows overlap and the split
is wrong — say so and report the measured totals plainly instead of publishing a negative remainder
or clamping it to zero. A clamped number looks correct and hides the defect.
Report the unaccounted remainder rather than distributing it. A visible gap is information; a
silently absorbed one is a wrong number.
Record every CI and release workflow run in `release_workflow_runs` as you watch it, using the run's
own `startedAt` and `updatedAt`. This makes the longest-wait figure in the summary a lookup instead
of a recollection. These rows are evidence about the run itself, so they are exempt from the
non-overlap rule — never sum them into `waiting`.
## Recording interactions
Insert a `release_interactions` row every time you put a gate, question, or review in front of the
user: write `prompted_at` when you ask, and fill `answered_at` from the timestamp of their reply.
**Close the open interaction before doing anything else with the user's reply.** At most one row per
stage should have a NULL `answered_at` at any moment -- the question you are currently waiting on.
When a reply arrives, your first action is to `UPDATE` that row with `answered_at` and `outcome`;
only then act on what they said. Deferring the update is how rows end up permanently NULL, because
by the time the work is done the arrival time is gone.
```sql
UPDATE release_interactions
SET answered_at = '{reply-timestamp}', outcome = '{what they decided}'
WHERE id = (SELECT MAX(id) FROM release_interactions WHERE answered_at IS NULL);
```
Two failure modes to avoid, both of which produce numbers that look fine and are wrong:
- **Never write `answered_at` equal to `prompted_at`.** A zero-duration interaction means the reply
timestamp was unavailable, not that the user answered instantly. Leave it NULL and count the row
as unmeasured.
- **Record choice-style prompts too.** A gate answered by picking an option is still interaction; if
the mechanism gives you no reply timestamp, log the row with NULL `answered_at` so it appears in
the unmeasured count rather than vanishing.
At wrap-up, report how many interactions were measured and how many were not. That belongs in the
narrative prose, not in the timing table: "~27m across six gates, four more unmeasured" is an honest
floor, while the table's cells stay clean and carry only the `~` estimate marker.
**Always set `stage` on the interaction row.** The closing summary reports interaction time per stage
alongside each stage's elapsed time, which is what makes the table actionable -- a 2h 22m stage
costing ~11m of your attention reads very differently from one costing ~2h. That roll-up is only
possible if every interaction is attributed when it is recorded:
```sql
SELECT stage,
SUM(strftime('%s', answered_at) - strftime('%s', prompted_at)) AS measured_seconds,
SUM(answered_at IS NULL) AS unmeasured
FROM release_interactions
GROUP BY stage;
```
A stage whose interactions all lack a usable reply timestamp reports `—`, not `~0m`. `~0m` means the
stage had no interactions, or its measured intervals rounded to zero -- it asserts that the stage
cost the user no material time, which is a claim you can only make from data you actually have.
The interval between `prompted_at` and `answered_at` is the user's **think-and-respond time**. Sum
those intervals to estimate **active user-interaction time**. Do not treat the rest of the session as
waiting by subtraction -- take waiting from `release_waits` and report the remainder as unaccounted.
Apply judgement when summing:
- Discard or cap any single interval that clearly represents the user stepping away rather than
engaging -- an overnight gap between a gate and its answer is wait time, not interaction time.
Note in the summary that such a gap was excluded.
- Long stretches where the user reviews a diff, release notes, or a PR **are** interaction time even
though you were idle.
- Always label the result as an estimate, and state the measured/unmeasured split alongside it.
## Progress rail
Render the rail from the latest attempt of each stage in `release_stages` at every gating prompt:
```
[✓] 1 Prepare → [●] 2 Review and merge → [ ] 3 Publish → [ ] 4 Release → [ ] 5 Verify
```
Use `✓` for done, `●` for in progress, `⚠` for blocked, `↩` for carried over, and a blank for
pending. Add the current sub-step after the rail when one is active, for example
`current: waiting on CI (2 checks running)`.

View file

@ -0,0 +1,108 @@
# Release Wrap-Up Summary
Present this summary when the release is complete: the GitHub release is published, both the release
and docs workflows have succeeded, the packages are listed on NuGet.org, and the docs site reflects
the release.
The tone is short and celebratory. It is a chat message to the user -- **do not commit it, do not
post it to GitHub, and do not write it to a file** unless the user explicitly asks.
Build the timing sections from the `release_stages`, `release_interactions`, `release_waits`, and
`release_workflow_runs` tables described in [session-tracking.md](session-tracking.md).
## Template
```markdown
🎉 **v{version} is released.**
{One or two sentences on the release theme, echoing the preamble that shipped in the release notes.}
**Shipped**
| | |
|---|---|
| Version | `v{version}` |
| Base branch | `{base branch}` |
| Release PR | #{pr} |
| Release | {release URL} |
| Release workflow | {run URL} — {conclusion} |
| Docs workflow | {run URL} — {conclusion} |
| NuGet | {listed package versions, or the package listing URL} |
| Docs | https://csharp.sdk.modelcontextprotocol.io/{version-slug}/ — live |
**Packages**
* {package name} {version}
* {package name} {version}
**Stage timing (this session)**
| Stage | Status | Elapsed | Interactions |
|---|---|---|---|
| 1. Prepare | ✓ | {h m} | ~{h m} |
| 2. Review and merge | ✓ | {h m} | ~{h m} |
| 2. Review and merge (attempt 2) | ✓ | {h m} | ~{h m} |
| 3. Publish | ✓ | {h m} | ~{h m} |
| 4. Release | ✓ | {h m} | ~{h m} |
| 5. Verify | ✓ | {h m} | ~{h m} |
| **Total session** | | **{h m}** | **~{h m}** |
{Include an attempt row only when a stage was reworked, and say what forced it -- "CI red, corrective
push". Aggregating rework into one row hides where the time actually went.}
**Where the time went**
* Active interaction — ~{h m} across {n} measured gates{, plus {n} unmeasured}
* Waiting on builds, CI, and the release and docs workflows — ~{h m}
* Unaccounted — {h m}
* Longest single wait — {h m} ({what you were waiting on})
{Optional: one line on anything notable — a blocked stage and how long it cost, an excluded
step-away gap, or a stage that ran unusually long or short.}
**Follow-ups**
* {Anything deferred during the release, or "None."}
* {Worktrees still on disk for this release, offered for cleanup, or omit this line.}
```
## Rules
1. **Only report what you observed.** Stages recorded as `carried_over` show `↩ carried over from a
previous session` in the Status column and `—` for Elapsed. They are excluded from the total, and
a footnote says the total covers this session only.
2. **Total session** is wall-clock from `session_started_at` to now, not the sum of stage elapsed
times -- gaps between stages belong to the session but to no stage.
3. **The Interactions column is per-stage active user time.** Sum that stage's
`release_interactions` prompt-to-answer intervals and prefix with `~`: `~5m`, `~1h 3m`. Show
`~0m` when the stage had no interactions at all, or when its measured intervals round to zero.
Show `—` when the stage *did* have interactions but none of them carry a usable reply timestamp --
that is missing data, not zero time, and must never be rendered as `~0m` or fabricated.
Carried-over stages show `—` in both time columns.
4. **`~` is the only qualifier the table needs.** Never append "minimum", "at least", or a similar
hedge to a cell -- the tilde already says the figure is estimated, and the table stays scannable.
When stages show `—` or interactions went unmeasured, explain that in the narrative prose below
rather than in the table.
5. **Active interaction time is always an estimate.** Label it with `~` and say it is estimated from
prompt-to-answer intervals. In the narrative, report it as a floor with the unmeasured count
beside it -- interactions whose reply timestamp was unavailable are counted, not silently dropped.
Name any interval you excluded as a step-away gap.
6. **Reconcile the narrative with the table.** The `Active interaction` bullet must equal the table's
total interaction cell. Where the two could differ -- excluded step-away gaps, `—` stages,
zero-duration rows discarded as unmeasured -- name the discrepancy explicitly rather than letting
the reader find it.
7. **Waiting time is measured, not inferred.** Sum the `release_waits` intervals. Never derive it by
subtracting interaction time from the session total; that counts diagnosis and rework as waiting.
Show whatever the two do not account for as `Unaccounted` rather than folding it into either.
**If `Unaccounted` computes negative, wait and interaction rows overlapped** — the split is
unsound, so omit the `Unaccounted` line, report the two measured totals, and state plainly that
they overlap. Never publish a negative figure and never clamp it to zero, which would present a
broken split as a clean one.
8. **Longest single wait comes from `release_waits` and `release_workflow_runs`**, not from the
longest interaction. If waits were not recorded, say the data is unavailable instead of
substituting the longest gate.
9. **Round to readable units.** `2h 14m`, `47m`, `3m`. Never show seconds.
10. **Omit rows and sections that do not apply.** No blocked stage means no note about one; no
follow-ups means the section says `None.` rather than disappearing.
11. **Never speculate about time.** If the session lacks the data for a section, say so plainly
instead of estimating.

View file

@ -2,6 +2,25 @@
This repository contains the official C# SDK for the Model Context Protocol (MCP), enabling .NET applications to implement and interact with MCP clients and servers.
## GitHub Interactions
### Commits and Pushes
- Never push to an active pull request without being explicitly asked. Always wait for explicit instructions to push.
- Never chain commit and push in the same command. Commit first, report what was committed, then wait for explicit push instructions. This creates a mandatory decision point.
### AI-Generated Content Disclosure
When posting any content to GitHub under a user's credentials — opening pull requests, creating issues, commenting on pull requests or issues, posting review comments, or taking any other public-facing action — include a concise, visible note (e.g. a `> [!NOTE]` alert) at the bottom indicating that the content was AI/Copilot-generated.
This disclosure is not required when:
- The account is a recognized bot or Copilot app account (for example, `github-actions[bot]` or `copilot`), where the AI origin is already apparent from the account identity.
- The user explicitly asks to omit the disclosure.
**Draft release notes** are a special case. Include the disclosure while the release is a draft, but
remind the user at the publishing handoff that they may remove it once they have thoroughly reviewed
and signed off on the notes — the published notes then stand as their own reviewed work. Removing it
is always the user's decision; never remove it on your own initiative, and never reintroduce it once
the user has removed it.
## Critical: Always Build and Test
**ALWAYS build and run tests before declaring any task complete or making a pull request.**

View file

@ -2,6 +2,12 @@
The following process is used when publishing new releases to NuGet.org.
The [`release-manager`](agents/release-manager.agent.md) custom agent orchestrates this process end
to end -- routing to the `prepare-release` and `publish-release` skills, holding a human gate at each
stage, tracking how long each stage takes, and closing with a release summary. Start it with a
prompt like "Where are we in the release process?" or "Prepare a release." The steps
below remain the authoritative description of the process itself.
## 1. Ensure the CI workflow is fully green
- Some integration tests are flaky and may require re-running
@ -12,11 +18,13 @@ The following process is used when publishing new releases to NuGet.org.
From a local clone of the repository, use Copilot CLI to invoke the `prepare-release` skill. The skill assesses the semantic version, bumps the version in [`src/Directory.Build.props`](../src/Directory.Build.props), runs API compatibility checks, reviews documentation, drafts release notes, and creates a pull request with all release artifacts.
As part of Step 9 (documentation review), the skill also updates the shared embedded NuGet README (`src/PACKAGE.md`) -- adding any newly introduced packages to the package-list closure, applying the correct badge style (`nuget/vpre` for a prerelease series or `nuget/v` for a stable release), adding a release-notes link pointing to the tag being created, and syncing the same closure changes to the root `README.md`.
Review the PR, request changes if needed, and merge when ready.
## 3. Publish the release
After the prepare-release PR is merged, invoke the `publish-release` skill. The skill checks for any late-arriving PRs that could affect the release, refreshes the release notes, and creates a **draft** GitHub release.
After the prepare-release PR is merged, invoke the `publish-release` skill. The skill checks for any late-arriving PRs that could affect the release, refreshes the release notes, re-runs the README content checklist (confirming package closure, badge style, and release-notes link), and creates a **draft** GitHub release.
Review the draft release on GitHub, check 'Set as a pre-release' if appropriate, and click 'Publish release'.
@ -29,8 +37,19 @@ Official NuGet.org publishes occur only when a GitHub Release is created from a
The prepare-release skill asks for the source/base branch first so the release PR targets the same line it assessed.
For the agent-facing, structured version of these rules, see [release-branches.md](skills/shared-resources/release-branches.md).
## 4. Monitor the Release workflow
## 4. Verify the release
- After publishing, a workflow will produce build artifacts and publish the NuGet packages to NuGet.org
- If the job fails, troubleshoot and re-run the workflow as needed
- Verify the package version becomes listed at [nuget.org/packages/ModelContextProtocol](https://www.nuget.org/packages/ModelContextProtocol)
Publishing the release triggers two workflows in parallel. Invoke the `verify-release` skill to
monitor both and confirm their published outputs:
- **Release** — produces build artifacts and publishes the NuGet packages to NuGet.org. If the job
fails, troubleshoot and re-run the workflow as needed. Verify the package version becomes listed
at [nuget.org/packages/ModelContextProtocol](https://www.nuget.org/packages/ModelContextProtocol).
- **[Publish Docs](workflows/docs.yml)** — rebuilds the versioned documentation site from the
published release tags and deploys it to
[csharp.sdk.modelcontextprotocol.io](https://csharp.sdk.modelcontextprotocol.io). Verify the new
version appears in the version picker and that its major-version path serves the updated content.
A content-only docs refresh can be run later via manual dispatch. Its `docs_source` input defaults
to `release-tags` to mirror a release deployment; select `latest-branches` to refresh every
published major from its current `release/{MAJOR}.x` branch, using `main` for its
matching major.

View file

@ -122,7 +122,7 @@ Before dismissing a potential break, review the PR description and all PR commen
Every dismissed potential break must be reported to the user with enough detail for them to verify the conclusion. The audit must:
1. **Identify what would normally be breaking and why** (e.g., "CP0005 — adding abstract member `Completion` to abstract class `McpClient`")
2. **Explain the specific reason for dismissal** (e.g., "Bug fix correcting incorrect behavior per the MCP spec" or "`McpClient`'s only accessible constructor is `protected` and marked `[Experimental(MCPEXP002)]` with message 'Subclassing McpClient and McpServer is experimental and subject to change.'")
2. **Explain the specific reason for dismissal** (e.g., "Bug fix correcting incorrect behavior per the MCP spec" or "`McpClient`'s only accessible constructor is `protected` and marked `[Experimental(MCPEXP002)]` with message 'This C# SDK extensibility API is experimental and subject to change.'")
3. **Cite any supporting discussion** from the PR description or comments (e.g., "Reviewers discussed the addition and did not flag it as a breaking concern; compatibility suppressions were added for CP0005")
4. **Conclude with the dismissal and its category** (e.g., "Dismissed — bug fix correcting spec-non-compliant behavior" or "Dismissed — exclusively gated by `[Experimental]` API. Do not apply the `breaking-change` label.")

View file

@ -22,7 +22,7 @@ Read `src/Directory.Build.props` on the current branch and extract:
The candidate version is `{VersionPrefix}` plus `-{VersionSuffix}` when the suffix is present (for example, `2.0.0-preview.1`). Display the current candidate version to the user.
Determine the previous release tag from `gh release list` (most recent **published** release). Draft releases must be ignored — they represent a pending release that has not yet shipped. Use `--exclude-drafts` or filter to only published releases when querying. The lookup is branch-aware: from a `release/{MAJOR}.x` branch, restrict candidates to tags matching `v{MAJOR}.*`; from `main`, use the most recent published release globally. See [release-branches.md](../shared-resources/release-branches.md) for details.
Determine the previous release tag from `gh release list` — the **highest semver** among published releases that are ancestors of the target commit, not the most recently published by date. Draft releases must be ignored — they represent a pending release that has not yet shipped. Use `--exclude-drafts` or filter to only published releases when querying. The lookup is branch-aware: from a `release/{MAJOR}.x` branch, restrict candidates to tags matching `v{MAJOR}.*`; from `main`, there is no MAJOR filter. See [release-branches.md](../shared-resources/release-branches.md#previous-release-tag-lookup) for details, including why date ordering picks the wrong tag.
### Step 2: Assess and Determine Next Version

View file

@ -62,11 +62,11 @@ While the candidate version uses a prerelease suffix (e.g., `X.Y.Z-preview.N`, `
Going to GA drops the suffix entirely: `2.0.0-rc.2` → `2.0.0`.
This is purely about how to *compute* the next version. It does **not** declare any new policy about what kinds of changes are permitted between previews — refer to the existing [versioning documentation](../../../../docs/versioning.html) for breaking-change policy.
This is purely about how to *compute* the next version. It does **not** declare any new policy about what kinds of changes are permitted between previews — refer to the existing [versioning documentation](../../../../docs/versioning.md) for breaking-change policy.
### Branch context
The "previous release" lookup is constrained to tags matching `v{MAJOR}.*` when assessing from a `release/{MAJOR}.x` servicing branch. On `main`, the lookup is unconstrained (most recent published release globally).
The "previous release" lookup selects the highest semver among published releases that are ancestors of the target commit, constrained to tags matching `v{MAJOR}.*` when assessing from a `release/{MAJOR}.x` servicing branch. On `main`, there is no MAJOR filter. It is not a date-ordered lookup; see [release-branches.md](../../shared-resources/release-branches.md#previous-release-tag-lookup).
The MAJOR/MINOR/PATCH classification criteria above are unchanged regardless of branch.

View file

@ -18,6 +18,27 @@ Use the shared [release branch reference](../shared-resources/release-branches.m
Work through each step sequentially. Present findings at each step and get user confirmation before proceeding. Skip any step that has no applicable items.
### Step 0: Sync With Upstream
Every later step reads branches, tags, and file contents from the local repository. Stale local refs
produce assessments that are wrong in ways that look plausible: a missing tag makes a released
version invisible, and a stale branch hides merged PRs. Establish a complete, current view before
reading anything.
1. Identify the remote that points at the canonical repository (`modelcontextprotocol/csharp-sdk`).
Do not assume it is named `origin` — in a fork-based checkout `origin` is often the fork:
`git remote -v`
2. Fetch that remote's branches **and tags**, pruning deleted refs:
`git fetch {upstream} --prune --prune-tags --tags`
3. Confirm the tag for the most recent published release exists locally and resolves:
`git rev-parse --verify v{previous}^{commit}`
Report what changed as a result of the fetch — new tags, updated branch heads — so the user can see
whether the starting state was stale.
Read every subsequent step's branch state from the remote-tracking refs (`{upstream}/main`,
`{upstream}/release/{MAJOR}.x`), not from local branches, which may lag or have diverged.
### Step 1: Select Source Branch
List candidate source/base branches via:
@ -40,9 +61,21 @@ The user may provide:
- **No context** — show the last 5 commits on the selected source/base branch (noting HEAD) and offer the option to enter a branch or tag name instead
Once the target is established:
1. Determine the previous release tag from `gh release list` (most recent **published** release — exclude drafts with `--exclude-drafts`). Use the selected source/base branch context: on `release/{MAJOR}.x`, restrict candidates to tags matching `v{MAJOR}.*`; on `main`, use the most recent published release globally.
1. Determine the previous release tag from `gh release list` — the **highest semver** among published releases that are ancestors of the target commit (exclude drafts with `--exclude-drafts`). Do not order by publication date; see [release-branches.md](../shared-resources/release-branches.md#previous-release-tag-lookup) for why the two differ and what breaks. On `release/{MAJOR}.x`, restrict candidates to tags matching `v{MAJOR}.*`; on `main`, there is no MAJOR filter.
2. Get the full list of PRs merged between the previous release tag and the target commit on the selected branch.
3. Read `src/Directory.Build.props` **at the target commit**. Extract `<VersionPrefix>` and `<VersionSuffix>`; the **candidate version** is `{VersionPrefix}` plus `-{VersionSuffix}` when the suffix is present (for example, `2.0.0-preview.1`).
4. **Verify the previous release tag is an ancestor of the target commit:**
`git merge-base --is-ancestor v{previous} {target}`
If it is not an ancestor, stop and report. The two histories have diverged, which means the
selected source branch is not a continuation of the previous release. Every downstream
conclusion would be wrong: the PR range would be computed across unrelated history, and the
ApiCompat baseline in Step 7 would report the previous release's entire API surface as removed.
This is a source-selection problem, not a compatibility problem — do not attempt to suppress it.
The usual cause is that the previous release shipped from a different branch than the one
selected. Re-run Step 1 and choose the branch that actually contains the previous release, or
confirm with the user that a divergent source is intended and why.
### Step 3: Categorize and Attribute
@ -98,7 +131,7 @@ After the version is confirmed:
2. Update `src/Directory.Build.props`:
- Set `<VersionPrefix>` to the confirmed stable component
- Set `<VersionSuffix>` for prerelease versions, or clear it for stable versions; add the element if it is missing
- Update `<PackageValidationBaselineVersion>` when appropriate. For the `2.0.0-preview` series, baseline is `1.3.0` (latest shipped 1.x). For subsequent stable releases, baseline is the previous shipped version of the same MAJOR or the latest stable from the previous MAJOR.
- Update `<PackageValidationBaselineVersion>` when appropriate, per the rule in [references/apicompat-apidiff.md](references/apicompat-apidiff.md#updating-the-baseline-version). Read the current value from `src/Directory.Build.props` and derive the correct one from the versions actually published; never copy a version from an example. Show the derivation — current value, published versions considered, resulting value, and whether it changes — and get confirmation before editing. **If the value changes, the [baseline-transition suppression audit](references/apicompat-apidiff.md#baseline-transition-suppression-audit) is mandatory.**
3. Build the solution to verify the version change compiles: `dotnet build`
This step creates local changes only — nothing is committed or pushed yet.
@ -109,11 +142,19 @@ Run API compatibility validation against the baseline version. Follow [reference
1. Run `dotnet pack` to trigger package validation against `PackageValidationBaselineVersion`
2. Capture the ApiCompat output (compatibility issues, warnings, suppressions)
3. If there are unexpected compatibility breaks:
3. **If `PackageValidationBaselineVersion` changed in this release, run the baseline-transition suppression audit before interpreting anything else.** Moving the baseline makes suppressions written for the old baseline stale, and the resulting failure looks exactly like a mass breaking change.
4. If there are unexpected compatibility breaks:
- **First, check whether the output says `Unnecessary suppressions found`.** That is a hard failure in its own right, and the CP0001/CP0002/CP0005 lines beneath it are the listing of *unused suppression entries*, not live API breaks. Regenerate the suppression file and cross-check the API diff before believing them.
- **Then sanity-check the scale.** A large number of errors reporting *missing* API surface —
especially spanning whole feature areas — almost always means the baseline does not belong to
this branch's history, or that stale suppressions are being listed. Re-verify the ancestry check
from Step 2 before interpreting a single error. Never suppress your way out of this.
- Cross-reference with the breaking change audit from Step 4
- Present any unaccounted breaks to the user
- If breaks are intentional, add appropriate entries to `CompatibilitySuppressions.xml` in the affected project directory
4. Record the ApiCompat results for inclusion in the PR description
- If breaks are intentional, add appropriate entries to `CompatibilitySuppressions.xml` in the affected project directory — only after the suppression audit is complete
5. **Never adjust the thing being validated against in order to pass.** Do not change `PackageValidationBaselineVersion` to silence errors, do not set `ApiCompatPermitUnnecessarySuppressions`, do not `NoWarn` CP diagnostics, and do not disable package validation. The baseline is determined by what shipped; suppressions record user-confirmed intentional breaks. If validation fails unexpectedly, stop and report.
6. Confirm the plain CI-equivalent run passes with no generation flags: `dotnet clean -c Release; dotnet pack -c Release`
7. Record the per-package ApiCompat results — baseline, generated entry count, retained/removed suppressions, plain pack result — for Step 12 and the PR description
### Step 8: Generate API Diff Report
@ -130,31 +171,87 @@ Generate a human-readable diff of the public API surface between the previous re
Review repository documentation for changes needed to compensate for or adapt to this release:
1. **NuGet package READMEs** — Validate that code samples in `README.md` and `src/PACKAGE.md` compile against the current SDK. Follow [references/readme-snippets.md](references/readme-snippets.md) for the validation procedure. Propose fixes for any API mismatches.
2. **Conceptual documentation** — Review `docs/` for content affected by the changes in this release. Update references to changed APIs, new features, or removed functionality.
3. **Versioning documentation** — If the release introduces new versioning-relevant policies (new experimental APIs, obsoletion changes), verify `docs/versioning.md` reflects them.
4. **Changelogs** — If the repository contains changelog files (e.g., `CHANGELOG.md`), update them with the release information. If no changelogs exist, skip this sub-step and note it in the summary.
1. **NuGet package READMEs** -- Run the README content checklist from [references/readme-content.md](references/readme-content.md) and validate code samples:
a. **Content checklist** -- Open `src/PACKAGE.md` and verify each item in the checklist:
- **Package-list closure**: every shipping SDK package is listed. If a new package was introduced in this release, add it now. Use non-counting phrasing -- do not say "N main packages".
- **Badge strategy**: all package badges use `nuget/vpre` for a prerelease series or `nuget/v` for a stable release. Switch all badges together if the release type has changed.
- **Release-notes link**: add or update the link to `https://github.com/modelcontextprotocol/csharp-sdk/releases/tag/v{version}` for the confirmed release version. The tag does not yet exist at prepare time; the link is forward-referencing and resolves when the GitHub release is published.
- **Root README.md sync**: mirror any package-list closure changes in the root `README.md`.
- **Other salient content**: descriptions, getting-started links, version-specific notes.
b. **Snippet validation** -- Validate that `csharp`-fenced code blocks in `src/PACKAGE.md` and `README.md` compile against the current SDK. Follow [references/readme-snippets.md](references/readme-snippets.md) for the full procedure. Propose fixes for any API mismatches.
2. **Conceptual documentation** -- Review `docs/` for content affected by the changes in this release. Update references to changed APIs, new features, or removed functionality.
3. **Versioning documentation** -- If the release introduces new versioning-relevant policies (new experimental APIs, obsoletion changes), verify `docs/versioning.md` reflects them.
4. **Changelogs** -- If the repository contains changelog files (e.g., `CHANGELOG.md`), update them with the release information. If no changelogs exist, skip this sub-step and note it in the summary.
Stage all documentation changes for inclusion in the release commit.
**Edge Cases for README updates:**
- **New package introduced** -- Add it to the package-list closure in `src/PACKAGE.md` and `README.md`. Use the package's `<Description>` from its `.csproj` as the short description.
- **Release type changes (prerelease to stable or vice versa)** -- Switch all package badges between `nuget/vpre` and `nuget/v` together.
- **Release tag does not yet exist at prepare time** -- The release-notes link is forward-referencing; it is verified to resolve during the publish-release step.
### Step 10: Draft Release Notes
Compose the release notes that will appear in the PR description and serve as the foundation for the **publish-release** skill. This is a draft — the final release notes will be refreshed when the GitHub release is created.
1. **Preamble** — Draft a short paragraph summarizing the release theme. Present it to the user for review and editing. The preamble is **required**.
2. **Breaking Changes** — sorted most → least impactful (from Step 4 results). Include the versioning docs link.
2. **Breaking Changes** — sorted most → least impactful (from Step 4 results). Include the versioning docs link, using the `v{MAJOR}` slug for the version being released — see [release-branches.md](../shared-resources/release-branches.md#versioning-documentation-links).
3. **What's Changed** — chronological; includes breaking change PRs
4. **Documentation Updates** — chronological
5. **Test Improvements** — chronological
6. **Repository Infrastructure Updates** — chronological
7. **Acknowledgements**:
- New contributors (first contribution in this release)
- Issue reporters (cite resolving PRs)
- Issue reporters (cite resolving PRs) — **excluding maintainers**. Acknowledgements exist to
thank the community; a maintainer filing an issue in their own repository is ordinary
project work, not a contribution to credit. Determine maintainer status via
`gh api repos/{owner}/{repo}/collaborators/{user}/permission --jq .permission` and omit
anyone with `admin` or `write`. Maintainers still appear in the reviewers bullet.
- PR reviewers (single bullet, sorted by review count, no count shown)
8. **Full Changelog** link using the exact tag, including any suffix (for example, `v1.3.1` or `v2.0.0-preview.1`)
Omit empty sections. Present each section for user review before proceeding. Tag references in templates use `v{version}` exactly, including prerelease suffixes; the Full Changelog link compares the previous tag to the suffixed tag when applicable.
### Step 10b: Review Categorization and Acknowledgements With the User
**Do this before committing, and never defer it to the Step 12 summary.** Showing the finished
notes is not a substitute for this step. A complete, well-formatted set of release notes reads as
correct and does not invite scrutiny; users routinely approve it and then find miscategorized
entries afterward, once the PR is already open. Ask targeted questions while the answers are still
cheap to apply.
Present two compact review artifacts and stop for a response after each.
**1. Categorization table.** Every PR, its assigned section, and the reason — not just the
borderline ones, since the user cannot correct a call they were not shown:
| PR | Title | Section | Why |
|---|---|---|---|
| #{number} | {title} | {section} | {what the placement turned on} |
Then explicitly surface the judgment calls, naming the PRs and the reasoning that made each one
close:
> These were the close calls: {PRs} touch code but not shipped packages, so I placed them under
> {section}. Any of these belong in a different section?
Flag as a close call any PR that touches `samples/` or `tests/` but not `src/`, any PR placed in
"What's Changed" whose changes are confined to non-shipping paths, and any PR whose title suggests
a different section than the one you assigned.
**2. Acknowledgements roster.** Each person, why they are listed, and their maintainer status:
| Person | Reason | Maintainer? |
|---|---|---|
| @{handle} | {contribution or issue, and the PR that resolved it} | {yes/no — if yes, omit per Step 10 item 7} |
Show entries you excluded and why, so the user can overrule the omission. Ask directly whether the
remaining list is right, since acknowledgement errors are about people and are the least
comfortable thing to correct after publication.
Apply any corrections before Step 11. Record what changed so the same misclassification is not
reintroduced when publish-release refreshes the notes for late-arriving PRs.
### Step 11: Commit Changes
Commit all changes to the `release-{version}` branch:
@ -179,7 +276,7 @@ Present **all** of the following details to the user for review. The user must c
docs/experimental.md — Added new experimental API reference
```
6. **Draft release notes** — the complete release notes from Step 10
7. **API Compatibility results** — the ApiCompat output from Step 7
7. **API Compatibility results** — the per-package table from Step 7: baseline version, generated suppression count, retained/removed stale suppressions, and plain-pack result. Do not state that ApiCompat passed without these. Call out any change to `PackageValidationBaselineVersion` or to any suppression file explicitly.
8. **API Diff report** — the API diff from Step 8
9. **Proposed PR title** (e.g., `Release v2.0.0-preview.1`, `Release v1.3.1`)
10. **Proposed PR description** — the assembled content combining release notes, ApiCompat, and ApiDiff
@ -187,6 +284,11 @@ Present **all** of the following details to the user for review. The user must c
After presenting all details, explicitly ask the user:
> Would you like to push the branch and create the pull request?
Confirm the Step 10b review actually happened before asking. If categorization and acknowledgements
were never reviewed as their own decisions, go back and do that first — this gate is about
publishing mechanics, and burying content questions in it is how miscategorized entries reach an
open PR.
**Do not proceed without explicit "yes" confirmation.**
### Step 13: Push Branch and Create Pull Request
@ -201,12 +303,22 @@ Only after explicit user confirmation in Step 12:
- **Description**: The assembled PR description (see PR Description Template below)
- **Labels**: Apply appropriate labels (e.g., `release`)
3. Present the PR URL to the user
4. **Monitor CI to completion.** Creating the PR does not end this step. Watch every check on the new head SHA until it reaches a terminal state:
```sh
gh pr checks {pr-number} --watch
```
Then report a per-check table and an overall verdict of **green**, **running**, or **blocked**. Do not hand off with only the PR URL and an invitation to review — the user should not be the one to discover a red build.
5. **On failure**, retrieve the logs yourself (`gh run view {run-id} --log-failed`), distinguish product/API validation failures from infrastructure or tooling flakiness, and diagnose before proposing a rerun. For ApiCompat failures, apply the interpretation rules in [references/apicompat-apidiff.md](references/apicompat-apidiff.md) before concluding the release is breaking. Present the diagnosis and a proposed fix, then stop — pushing a fix needs the same explicit approval as the original push.
6. **Restart monitoring after every subsequent push** to the release branch, against the new head SHA. Checks from a previous SHA are stale and must not be reported as current.
**Important**: No draft GitHub release is created at this point. The **publish-release** skill handles release creation after this PR is merged.
## Edge Cases
- **PR spans categories**: categorize by primary intent
- **PR spans categories**: categorize by primary intent, and surface it as a close call at Step 10b
- **PR adds sample code or tests but no `src/` changes**: Documentation Updates or Test Improvements, not "What's Changed" — the shipped packages did not change
- **Issue reporter is a maintainer**: omit the acknowledgement; show it as an exclusion at Step 10b so the user can overrule
- **User recategorizes after the PR is open**: update the PR body, and record the correction so publish-release does not re-derive the original category
- **Copilot timeline missing**: fall back to `Co-authored-by` trailers to determine whether `@Copilot` should be a co-author; if still unclear, use `@Copilot` as primary author
- **No breaking changes**: omit the Breaking Changes section from release notes entirely
- **Single breaking change**: use the same numbered format as multiple
@ -215,12 +327,21 @@ Only after explicit user confirmation in Step 12:
- **Proposed MAJOR does not match branch MAJOR**: if the proposed version's MAJOR doesn't match the branch's MAJOR (for example, proposing `2.0.0-preview.2` on `release/1.x`), flag this as a warning and ask the user to confirm. Do not hard-fail. This is informational, not a policy enforcement.
- **Prerelease bump**: when the candidate version has a suffix like `preview.N`, the SemVer assessment may simply increment `N` rather than computing MAJOR/MINOR/PATCH. Refer to the SemVer assessment guide's Prereleases section.
- **No previous release**: if this is the first release, there is no previous tag; gather all PRs merged to the target
- **Previous release tag is not an ancestor of the target**: stop and re-select the source branch per Step 2. Do not compute a PR range or interpret ApiCompat results across divergent history, and do not suppress the resulting errors
- **Previous release tag missing locally**: re-run the Step 0 fetch with `--tags` before concluding the release does not exist; a tag absent locally is far more often a stale checkout than an unpublished release
- **ApiCompat tooling unavailable**: fall back to `dotnet pack` output; note in the PR description that full ApiCompat was run via package validation only
- **`Unnecessary suppressions found` in ApiCompat output**: the CP lines that follow are unused suppression entries, not live breaks. Run the baseline-transition suppression audit and cross-check the API diff before treating the release as breaking
- **Baseline version changed during preparation**: run the suppression audit for every shipping package, and decide deliberately between advancing the baseline (clearing stale suppressions) and keeping the existing one. Report the choice and its rationale at Step 12
- **ApiCompat passes locally but CI fails**: check whether local runs used generation flags. Only `dotnet clean -c Release; dotnet pack -c Release` reproduces CI
- **A check never starts**: a workflow skipped by a path filter or stuck in a queue is not a pass. Compare against the check set on previous release PRs before declaring green
- **Checks green on an earlier SHA**: stale. Re-watch against the current head after every push
- **CI fails for infrastructure reasons**: a single rerun is reasonable if the cause is clearly runner, network, or feed related. State the reason. Never rerun a product or API validation failure to make it disappear
- **API diff tool installation fails**: do not fall back to a manual summary; pause and present the installation error to the user, offering options to troubleshoot, skip the API diff section, or abort the release preparation
- **No changelogs in repo**: skip changelog updates; note in the summary
- **Branch already exists**: if `release-{version}` already exists locally or remotely, ask the user whether to reuse it, delete and recreate, or choose a different name
- **PackageValidationBaselineVersion update**: for the `2.0.0-preview` series, use `1.3.0`; for subsequent stable releases, use the previous shipped version of the same MAJOR or the latest stable from the previous MAJOR
- **CompatibilitySuppressions.xml**: when intentional breaks are found, add suppression entries and include the file in the commit; existing suppressions should be preserved
- **PackageValidationBaselineVersion update**: derive it per [references/apicompat-apidiff.md](references/apicompat-apidiff.md#updating-the-baseline-version) from the versions actually published, and show the derivation for confirmation. A change to this property makes the baseline-transition suppression audit mandatory
- **CompatibilitySuppressions.xml**: when intentional breaks are found, add suppression entries and include the file in the commit. Preserve existing suppressions **unless the baseline moved** — the audit may prove tracked entries stale, in which case removing them is the fix, not a regression
- **Versioning link for a brand-new MAJOR**: the `/v{MAJOR}/versioning.html` path does not exist until the release is published and the Publish Docs workflow runs. The link is forward-referencing at prepare time, like the release-notes tag link. Use the slugged form anyway; do not fall back to the unslugged URL.
- **User declines PR creation**: if the user declines at Step 12, leave the local branch intact so they can review, modify, or push manually
## PR Description Template
@ -236,7 +357,7 @@ The PR description combines release notes, ApiCompat, and ApiDiff into a single
### Breaking Changes
Refer to the [C# SDK Versioning](https://csharp.sdk.modelcontextprotocol.io/versioning.html) documentation for details on versioning and breaking change policies.
Refer to the [C# SDK Versioning](https://csharp.sdk.modelcontextprotocol.io/v{MAJOR}/versioning.html) documentation for details on versioning and breaking change policies.
1. **Description #PR**
* Detail of the break
@ -291,14 +412,14 @@ Refer to the [C# SDK Versioning](https://csharp.sdk.modelcontextprotocol.io/vers
The release notes section within the PR description uses the same format as the final GitHub release notes (used by the **publish-release** skill). This ensures consistency between the PR and the published release. Tag examples such as `v2.0.0-preview.1` are valid and should be used verbatim when the version has a prerelease suffix.
Omit empty sections. The preamble is **always required** — it is not inside a section heading.
Omit empty sections. The preamble is **always required** — it is not inside a section heading. The versioning link uses the `v{MAJOR}` slug for the version being released — see [release-branches.md](../shared-resources/release-branches.md#versioning-documentation-links).
```markdown
[Preamble — REQUIRED. Summarize the release theme.]
## Breaking Changes
Refer to the [C# SDK Versioning](https://csharp.sdk.modelcontextprotocol.io/versioning.html) documentation for details on versioning and breaking change policies.
Refer to the [C# SDK Versioning](https://csharp.sdk.modelcontextprotocol.io/v{MAJOR}/versioning.html) documentation for details on versioning and breaking change policies.
1. **Description #PR**
* Detail of the break

View file

@ -8,16 +8,16 @@ The SDK uses NuGet's [Package Validation](https://learn.microsoft.com/dotnet/fun
```xml
<EnablePackageValidation>true</EnablePackageValidation>
<PackageValidationBaselineVersion>1.0.0</PackageValidationBaselineVersion>
<PackageValidationBaselineVersion>{baseline}</PackageValidationBaselineVersion>
```
Read the current values rather than assuming them, and check whether any individual project overrides them — a project that opts out of validation still ships, and needs to be reported as unvalidated rather than quietly skipped.
### Running ApiCompat
1. **Pack the SDK packages** to trigger validation:
1. **Pack the SDK packages** to trigger validation. Enumerate the packable projects under `src/` and pack each one; the set of shipping packages grows over time, so do not work from a remembered list:
```sh
dotnet pack src/ModelContextProtocol.Core/ModelContextProtocol.Core.csproj
dotnet pack src/ModelContextProtocol/ModelContextProtocol.csproj
dotnet pack src/ModelContextProtocol.AspNetCore/ModelContextProtocol.AspNetCore.csproj
dotnet pack src/{project}/{project}.csproj
```
Or pack all at once:
```sh
@ -28,17 +28,96 @@ The SDK uses NuGet's [Package Validation](https://learn.microsoft.com/dotnet/fun
3. **Interpret results:**
- **No issues**: The API is backward-compatible with the baseline. This is the expected result for PATCH and MINOR releases.
- **`Unnecessary suppressions found`**: **Read this before concluding anything else.** See [Reading a failing run](#reading-a-failing-run) below — the CP lines that follow it are usually *not* live breaks.
- **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.
- **Suppressions needed**: If intentional breaking changes are confirmed, add entries to `CompatibilitySuppressions.xml` in the affected project directory — but only after completing the [baseline-transition suppression audit](#baseline-transition-suppression-audit).
### Reading a failing run
`Unnecessary suppressions found` is itself a **hard failure**, not a warning attached to some other
problem. When it appears, the `CP0001` / `CP0002` / `CP0005` lines printed after it are the tool's
**detailed listing of the suppression entries it considers unused**. They are not a list of live API
breaks, even though they are formatted identically and appear under the same error banner.
Misreading that listing is how a routine release turns into a phantom emergency. In this repo it
produced 312 apparent breaking changes across the Core Tasks API on a release whose only real
change was one additive method — and it did so convincingly, because 312 lines of CP0001 for
missing types reads exactly like a catastrophic regression.
Before classifying a release as breaking, confirm which of the two you are looking at:
1. **Regenerate the suppression file** (see the audit below). If the generated output is *empty*,
there are no live breaks and every tracked entry is stale.
2. **Cross-check the direct API diff.** If ApiDiff shows only the additions you expect, the CP lines
are not describing reality.
Never work around this with `ApiCompatPermitUnnecessarySuppressions`, `NoWarn` for CP diagnostics,
or by disabling baseline validation. Those hide the signal that tells you the suppressions and the
baseline have drifted apart, which is the one thing you need to know.
### 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`).
**A baseline that trails `VersionPrefix` is the expected steady state, not a stale value.** Through a MAJOR series the baseline deliberately stays put while `VersionPrefix` advances, so seeing `2.0.0` alongside a published `2.1.0` means the rule is being followed. Do not "fix" the gap — bumping the baseline mid-series triggers the audit below and invites the released API surface to be re-baselined against itself, silently discarding the compatibility guarantee the property exists to enforce.
**Any change to this property triggers the [baseline-transition suppression audit](#baseline-transition-suppression-audit).** Do not change it and interpret the resulting failures as breaking changes — the failures are expected until the suppressions are reconciled.
### Baseline-transition suppression audit
**Whenever `PackageValidationBaselineVersion` changes, run this audit before interpreting any
ApiCompat failure and before adding a single suppression entry.**
Suppression entries are scoped to the baseline they were generated against. They record "this
difference from *that* baseline is intentional." Move the baseline and the differences change, so
entries written for the old baseline may describe nothing at all — the API they excused is now
present on both sides. The tool reports those orphans as unnecessary, and the build fails.
For **every shipping project**:
1. Inventory the tracked suppressions:
```sh
ls src/*/CompatibilitySuppressions.xml
```
2. Regenerate what the *current* baseline actually requires, into a throwaway file so the tracked
one is not overwritten while you are still deciding:
```sh
dotnet clean src/{Project}/{Project}.csproj -c Release
dotnet pack src/{Project}/{Project}.csproj -c Release \
/p:ApiCompatGenerateSuppressionFile=true \
/p:ApiCompatSuppressionOutputFile={unique-temp-path}
```
Use the **final candidate version and the final baseline** — regenerating against a version you
are about to change invalidates the result.
3. Compare the generated entries against the tracked file, by count and by content.
| Generated | Tracked | Meaning | Action |
|---|---|---|---|
| Empty | Non-empty | Every tracked entry is stale for this baseline | Clear or delete the tracked file |
| Non-empty | Matches | Suppressions are current | Leave them alone |
| Non-empty | Differs | Some entries stale, some breaks genuinely need suppressing | Reconcile entry by entry, and confirm each remaining break with the user |
4. After clearing stale entries, rerun the plain CI-equivalent pack with no generation flags, and
require it to pass on its own:
```sh
dotnet clean -c Release
dotnet pack -c Release
```
Reverting the baseline is the other valid resolution, and sometimes the better one — it keeps the
release diff minimal. Choose deliberately between "advance the baseline and clear the stale
suppressions" and "keep the existing baseline", rather than letting the choice be made by whichever
one silences the error first. Either way, the baseline is determined by what shipped, never selected
to make validation pass.
### 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.
When intentional breaking changes are confirmed, create or update `CompatibilitySuppressions.xml` in the affected project directory — the conventional location, which is auto-discovered.
**A suppression file has three valid outcomes, not one.** Entries get *added* when a new intentional break needs suppressing, *retained* when they still describe a real break against the current baseline, and *cleared* when the baseline moved and they no longer describe anything. Treating the file as append-only is what turned 312 obsolete entries into a release-blocking failure that read as a mass breaking change. Preservation is the default only while the baseline holds still; once it moves, the [audit](#baseline-transition-suppression-audit) decides what stays, and removing entries it proves stale is the fix rather than a regression.
Do not use a tracked file as a template for what entries should look like — it may legitimately be empty, and its contents describe whatever baseline it was generated against, not yours. Generate entries instead.
```xml
<?xml version="1.0" encoding="utf-8"?>
@ -53,7 +132,28 @@ When intentional breaking changes are confirmed, create or update `Compatibility
</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).
The exact suppression entries are generated by the pack command when it reports errors — copy the suggested suppression XML from the build output, or generate the file directly with `/p:ApiCompatGenerateSuppressionFile=true`. Remember that suppressions are needed **per target framework** (net10.0, net9.0, net8.0, netstandard2.0).
#### Wiring the suppression file
A `CompatibilitySuppressions.xml` sitting in the project directory is **auto-discovered**. That is
the convention this repo uses, and it needs no wiring at all. Do not add MSBuild properties or items
to point at a file that is already found by convention — duplicate or incorrect wiring is easy to
add while chasing a failure and hard to spot afterward, and it ships in the release commit.
If you do need an explicit path:
| Name | Kind | Use |
|---|---|---|
| `CompatibilitySuppressionFilePath` | **Property** | The supported way to point at a suppression file explicitly |
| `ApiCompatSuppressionFile` | **Item** | Not a property. Setting it via `/p:` does nothing |
| `ApiCompatSuppressionOutputFile` | **Property** | Where `ApiCompatGenerateSuppressionFile=true` writes its output |
Retaining an empty suppressions file is fine when you want to keep the file in place after clearing
stale entries. It must still be **valid XML** — an empty `<Suppressions>` root, not a zero-byte
file — and it must preserve the repository's byte conventions for these files, including the
UTF-8 BOM and the final newline. A file that differs only in BOM or trailing newline produces a
confusing diff and can trip tooling that round-trips it.
### Common Diagnostic IDs
@ -191,14 +291,37 @@ _or_
[Diff or table of changes]
```
### In the User Summary (Step 11)
### In the User Summary (Step 12)
Present a condensed version for the user review:
Present a condensed version for the user review. **Report every shipping package, and do not state
that ApiCompat passed without these four facts** — "passed" is not meaningful without knowing what
it was validated against and whether stale suppressions were masking or manufacturing the result:
- **ApiCompat**: pass/fail with count of issues and suppressions per package
- **ApiDiff**: count of additions, removals, and changes per package
| Package | Baseline | Generated entries | Retained / removed | Plain pack |
|---|---|---|---|---|
| {package} | {baseline} | 0 | 0 retained / 312 removed | ✅ |
| {package} | {baseline} | 0 | 0 / 0 | ✅ |
Enumerate the packable projects under `src/` rather than working from a remembered list; the set
grows. A package that does not participate in validation still gets a row, reporting why — a first
release has no baseline to compare against, and that is a fact worth stating rather than an absence
worth hiding.
- **Baseline** — the `PackageValidationBaselineVersion` actually used, and whether it changed during
this release
- **Generated entries** — count from `ApiCompatGenerateSuppressionFile=true` at the final version
and baseline
- **Retained / removed** — tracked suppressions kept versus cleared as stale
- **Plain pack** — result of the CI-equivalent `dotnet clean -c Release; dotnet pack -c Release`
with no generation flags, which is the run CI will reproduce
Then the summary lines:
```
API Compatibility: ✅ All 3 packages pass (2 existing suppressions in Core)
API Compatibility: ✅ All {n} packages pass against v{baseline} ({n} stale suppressions removed from {package})
API Diff: +12 additions, -2 removals, ~3 changes across all packages
```
If the baseline changed, or any suppression file was modified, say so explicitly and explain why.
A silent baseline or suppression edit is the kind of change that passes local validation and then
fails CI.

View file

@ -11,14 +11,30 @@ Feature work, bug fixes, API improvements, performance enhancements, and any oth
- Changes that span code + docs (categorize based on the primary intent)
### Documentation Updates
PRs whose **sole purpose** is documentation. Examples:
PRs whose **sole purpose** is documentation, guidance, or examples. 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
- **Adding or improving samples** under `samples/`, including new executable sample projects
- Clarifying how consumers should use existing behavior, even when the PR touches tests to
demonstrate or lock in that behavior
**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.
**The test that matters is whether the shipped packages changed**, not whether the PR contains
code. A PR that adds a whole new sample application is still a documentation update: nothing in
`src/` shipped differently because of it. Ask "would a consumer upgrading the NuGet package
observe any difference?" If no, it belongs here.
**Important**: A PR that changes shipped product code under `src/` AND updates docs should go in
"What's Changed" — only PRs that leave the shipped surface untouched 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.
Categorize conservatively: when a PR could plausibly land in either "What's Changed" or
"Documentation Updates", prefer "Documentation Updates" and surface the call to the user at the
categorization review. Overstating a docs PR as product work inflates the apparent scope of a
release, and it is the error users notice and correct.
### Repository Infrastructure Updates
PRs that maintain the development environment but don't affect the shipped product or test coverage. Examples:
@ -114,3 +130,6 @@ Sort entries within each section by **merge date** (chronological order, oldest
* @user submitted issue #1234 (resolved by #5678)
* @user1 @user2 @user3 reviewed pull requests
```
Do not acknowledge maintainers as issue reporters or new contributors; see Step 10 item 7. They
belong only in the reviewers bullet.

View file

@ -0,0 +1,94 @@
# README Content Checklist
This reference describes what to review and update in the shared embedded NuGet README
(`src/PACKAGE.md`) and the root repository README (`README.md`) as part of every release.
## The Shared Embedded README
All SDK packages embed the **same** README file: `src/PACKAGE.md`.
Each project packs it identically:
```xml
<None Include="..\PACKAGE.md" Pack="true" PackagePath="\README.md" />
<PackageReadmeFile>README.md</PackageReadmeFile>
```
Updating `src/PACKAGE.md` updates every package's nuget.org README at once.
There are no per-package README files; `src/ModelContextProtocol.Core/README.md` and
similar paths do not exist.
## Checklist
### 1. Package-list closure
Every shipping SDK package must be listed in the packages section of `src/PACKAGE.md`,
including packages introduced after the initial SDK launch and including the package
being viewed in its own embedded README on nuget.org.
Current packages to list:
- `ModelContextProtocol.Core`
- `ModelContextProtocol`
- `ModelContextProtocol.AspNetCore`
- `ModelContextProtocol.Extensions.Apps`
Avoid counting phrases such as "three main packages" -- they become stale when packages
are added. Use a non-counting closure such as "The SDK packages are:" instead.
When a new package is introduced, add it to the list in both `src/PACKAGE.md` and the
root `README.md` (see section below).
### 2. Badge strategy
Each package entry carries a nuget.org version badge. The correct badge endpoint depends
on the release type:
| Release type | Badge endpoint | Example |
|---|---|---|
| Prerelease series (e.g., `2.0.0-preview.*`) | `nuget/vpre/{package}` | `https://img.shields.io/nuget/vpre/ModelContextProtocol.svg` |
| Stable release | `nuget/v/{package}` | `https://img.shields.io/nuget/v/ModelContextProtocol.svg` |
`nuget/v` renders only the latest stable version and shows nothing (or a placeholder)
during a prerelease-only series. `nuget/vpre` renders the latest version including
prereleases. Switch all package badges together when the release type changes.
Verify every badge in `src/PACKAGE.md` uses the correct endpoint for this release.
### 3. Release-notes link
`src/PACKAGE.md` must contain one statement linking to the release notes for the
current version:
```markdown
See the [release notes](https://github.com/modelcontextprotocol/csharp-sdk/releases/tag/v{version})
for what's new in this version.
```
Replace `{version}` with the exact version being released, including any prerelease
suffix (e.g., `2.0.0-preview.2`).
At prepare time the tag does not yet exist; the link is forward-referencing. The link
resolves once the GitHub release is published during the publish-release step.
Update this link for every release -- it must point to the tag being created, not a
prior release.
### 4. Root README.md sync
The root `README.md` (the GitHub repo readme, NOT packed into packages) has its own
package-list section. Keep it aligned with `src/PACKAGE.md`:
- Same set of packages listed
- Same non-counting closure phrasing
- Badge strategy in `README.md` may also be updated for consistency, but the root
README is visible on GitHub (not nuget.org) so the badge choice is less critical
## Salient content to review
Beyond the structural checks above, read the current `src/PACKAGE.md` for any content
that has become stale due to changes in this release:
- Package descriptions (are they still accurate?)
- Getting-started links (do they resolve and describe the current API?)
- Code samples, if any (do they compile against the current SDK? see
[readme-snippets.md](readme-snippets.md))
- Any version-specific notes from a prior release that should be removed or updated

View file

@ -4,19 +4,21 @@ This reference describes how to validate that C# code samples in README files co
## 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:
Validate code samples from the **package README** and the root repository README:
| README | Package |
|--------|---------|
| `README.md` (root) | ModelContextProtocol |
| `src/ModelContextProtocol.Core/README.md` | ModelContextProtocol.Core |
| `src/ModelContextProtocol.AspNetCore/README.md` | ModelContextProtocol.AspNetCore |
| README | Notes |
|--------|-------|
| `src/PACKAGE.md` | The single shared embedded README packed into every SDK package. This is the primary documentation users see on nuget.org. |
| `README.md` (root) | The GitHub repository readme. Not packed into packages, but visible to developers browsing the repo. |
Sample README files (`samples/*/README.md`) are excluded — the samples themselves are buildable projects and are validated by CI.
All SDK packages embed `src/PACKAGE.md` via their `.csproj` files. There are no per-package
README files; paths such as `src/ModelContextProtocol.Core/README.md` do not exist.
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.
Extract only fenced code blocks tagged as `csharp` (` ```csharp `) from `src/PACKAGE.md` and `README.md`. Skip blocks tagged as plain ` ``` ` (shell commands, install instructions) or any other language.
### Handling Incomplete Snippets

View file

@ -16,6 +16,19 @@ Use the shared [release branch reference](../shared-resources/release-branches.m
Work through each step sequentially. Present findings at each step and get user confirmation before proceeding.
### Step 0: Sync With Upstream
This skill reads the merged release PR, the commit range since the previous release, and the
previous release tag. All three come from local refs that may be stale — most importantly, the
merge commit for the release PR will not exist locally until you fetch.
1. Identify the remote pointing at `modelcontextprotocol/csharp-sdk` (`git remote -v`) — do not
assume it is `origin`.
2. `git fetch {upstream} --prune --prune-tags --tags`
3. Confirm the merged release PR's merge commit resolves locally.
Report anything the fetch changed before continuing.
### Step 1: Identify the Prepare-Release PR
The user may provide:
@ -31,7 +44,7 @@ Verify the PR is merged. Extract:
### Step 2: Determine Version and Commit Range
1. Read `src/Directory.Build.props` at the merge commit to confirm `<VersionPrefix>` and `<VersionSuffix>`. The tag is `v{VersionPrefix}` plus `-{VersionSuffix}` when the suffix is present; for example, `<VersionPrefix>2.0.0</VersionPrefix>` + `<VersionSuffix>preview.1</VersionSuffix>` → `v2.0.0-preview.1`.
2. Determine the previous release tag from `gh release list` (most recent **published** release — exclude drafts with `--exclude-drafts`). The lookup is branch-aware: when the merge commit is on a `release/{MAJOR}.x` branch, restrict candidates to tags matching `v{MAJOR}.*`; on `main`, use the most recent published release globally. See [release-branches.md](../shared-resources/release-branches.md).
2. Determine the previous release tag from `gh release list` — the **highest semver** among published releases that are ancestors of the merge commit (exclude drafts with `--exclude-drafts`). Do not order by publication date. When the merge commit is on a `release/{MAJOR}.x` branch, restrict candidates to tags matching `v{MAJOR}.*`; on `main`, there is no MAJOR filter. See [release-branches.md](../shared-resources/release-branches.md#previous-release-tag-lookup).
3. Identify the full commit range: previous release tag → merge commit.
### Step 3: Check for Additional PRs
@ -67,16 +80,45 @@ Re-categorize all PRs in the commit range (including any new ones from Step 3).
1. **Re-run the breaking change audit** using the **breaking-changes** skill if new PRs were found that may introduce breaks. Otherwise, carry forward the results from the prepare-release PR.
2. **Re-categorize** all PRs into sections (What's Changed, Documentation, Tests, Infrastructure).
3. **Re-attribute** co-authors for any new PRs by harvesting `Co-authored-by` trailers from all commits in each PR.
4. **Update acknowledgements** to include contributors from new PRs.
4. **Update acknowledgements** to include contributors from new PRs, excluding maintainers as issue reporters (see prepare-release Step 10 item 7).
5. **Carry forward the prepare-release categorization decisions.** If the user recategorized a PR or removed an acknowledgement during preparation, honor that. Re-deriving categories from scratch will silently reintroduce the exact corrections they already made.
6. **Review with the user** using the categorization table and acknowledgements roster from prepare-release Step 10b — at minimum for PRs new since preparation, and for any entry whose section you changed. Do not fold this into the Step 9 draft-creation gate.
### Step 5: Validate README Code Samples
### Step 5: Review README and Validate Code Samples
Verify that all C# code samples in the package README files compile against the current SDK at the merge commit. Follow the [README validation guide](../prepare-release/references/readme-snippets.md) for the full procedure.
Re-run the README content checklist from [../prepare-release/references/readme-content.md](../prepare-release/references/readme-content.md) and validate code samples against the current SDK at the merge commit. Produce final suggestions before the release is created.
1. Extract `csharp`-fenced code blocks from `README.md` and `src/PACKAGE.md`
2. Create a temporary test project at `tests/ReadmeSnippetValidation/`
3. Build and report results
4. Delete the temporary project
1. **Content checklist** -- Open `src/PACKAGE.md` and verify:
- **Package-list closure**: every shipping SDK package is listed. If a new package was introduced after prepare-release ran, it may be missing.
- **Badge strategy**: all badges use `nuget/vpre` for a prerelease or `nuget/v` for a stable release. Verify the badge style is correct for this release type.
- **Release-notes link**: the link points to `https://github.com/modelcontextprotocol/csharp-sdk/releases/tag/v{version}` for the tag being created. The tag is about to exist -- verify the URL is correct.
- **Root README.md sync**: confirm the root `README.md` package list is aligned.
2. **Snippet validation** -- Extract `csharp`-fenced code blocks from `src/PACKAGE.md` and `README.md`, build the temporary test project, and report results. Follow [../prepare-release/references/readme-snippets.md](../prepare-release/references/readme-snippets.md) for the full procedure.
3. **Delete** the temporary project after validation.
If issues are found, present them to the user with proposed fixes.
**Applying them is not a local commit.** The release PR is already merged, so its branch is gone;
fixes belong on the base branch this release ships from (`main` or `release/{MAJOR}.x`), which is
protected. Open a small PR for them, let CI run, and merge it — do not push to the base branch
directly, and do not amend or re-tag anything already reviewed.
Then **re-target the draft release**, which is pinned to the previously approved merge commit and
therefore does not contain the fix:
```sh
gh release edit v{version} --target {new-merge-commit-sha}
```
Regenerate the release notes afterward so the commit range covers the new PR, and re-run the Step 6
section review for anything that changed. If the user prefers not to take the fix in this release,
that is a valid choice — leave the draft pinned where it is and note the deferred item, rather than
carrying a fix that the tag will not include.
**Edge Cases:**
- **Stale package closure** -- A package introduced between prepare-release and now may not be listed. Add it to `src/PACKAGE.md` and `README.md`.
- **Wrong badge style for the release type** -- Switch all badges together from `nuget/vpre` to `nuget/v` (or vice versa) if the prepare-release step used the wrong style.
- **Missing or incorrect release-notes link** -- Correct the link to target the exact tag being created, including any prerelease suffix.
### Step 6: Review Sections
@ -92,7 +134,7 @@ Highlight any changes from the prepare-release draft (new entries, reordered ent
### Step 7: Preamble
Every release **must** have a preamble — a short paragraph summarizing the release theme that appears before the first `##` heading. The preamble is not optional. The preamble may mention the presence of breaking changes as part of the theme summary, but the versioning documentation link belongs under the Breaking Changes heading (see template), not in the preamble.
Every release **must** have a preamble — a short paragraph summarizing the release theme that appears before the first `##` heading. The preamble is not optional. The preamble may mention the presence of breaking changes as part of the theme summary, but the versioning documentation link belongs under the Breaking Changes heading (see template), not in the preamble. That link must use the `v{MAJOR}` slug for the version being released.
Extract the draft preamble from the prepare-release PR description and present it alongside a freshly drafted alternative (accounting for any new PRs).
@ -113,11 +155,65 @@ Display release metadata for user review:
- **Target**: merge commit SHA, its message, the merge commit's branch (the prepare-release PR base), and the prepare-release PR link
After confirmation:
- Create with `gh release create --draft {tag} --target {merge-commit-branch}` (always `--draft`), using the prerelease tag verbatim when present
- Create with `gh release create --draft {tag} --target {merge-commit-sha}` (always `--draft`), using the prerelease tag verbatim when present
- **Target the full commit SHA, never a branch name.** A draft sits unpublished until a human
reviews and publishes it, which can be hours. `--target` is resolved when the tag is created --
at publish time, not now -- so a branch name silently re-resolves to whatever landed on that
branch in the meantime. The tag would then be cut at a commit nobody reviewed, and the release
notes would describe a different commit than the one shipped. The SHA you displayed above is the
commit the user approved; pass that exact SHA.
- **Never publish.** If the user asks to publish, decline and instruct them to publish manually.
Pinning the SHA costs nothing, because a draft release does not create the git tag. GitHub stores
the target and creates the tag only when the release is published, so the tag remains uncreated and
the draft fully editable while it waits.
That is also what makes a late-arriving commit easy to absorb. If the user decides to include work
that merged after the draft was created, do not delete and recreate the release: repoint it with
`gh release edit {tag} --target {new-commit-sha}`, then regenerate the release notes for the new
range and present them for approval again. Never move the target without revising the notes to
match -- a target change silently alters what shipped.
Then hand off to the user with the publishing checklist:
> The draft release is ready at {release URL}. Before publishing:
>
> 1. Review the release notes line by line — this is the last review before they are public.
> 2. Check **Set as a pre-release** if this is a prerelease.
> 3. Once you have signed off on the notes, **remove the AI-generated disclosure note** from the
> bottom of the body. It is there because the draft was AI-drafted; after your thorough review
> and sign-off, the published notes stand as your reviewed work.
> 4. Click **Publish release**.
The disclosure is removed by the **user**, as part of their sign-off — never remove it yourself, and
never remove it from a pull request description, an issue, or a comment. If the user asks you to
edit the draft body after they have removed it, do not reintroduce it.
When the user requests revisions after the initial creation, always rewrite the complete body as a file — never perform in-place string replacements. See [references/formatting.md](references/formatting.md).
### Step 10: Watch for Publication
Do not end the skill by asking the user to report back when they have published. Poll the release
until it is no longer a draft:
```sh
gh release view v{version} --json isDraft,publishedAt,tagName,isPrerelease
```
Poll at a modest interval — this gate is human-paced and may span hours or a session boundary. Say
that you are watching rather than going silent.
When `isDraft` becomes `false`:
1. Record the publication time from `publishedAt`, not from when the poll noticed.
2. Confirm the tag that was actually created and whether the release was marked as a prerelease.
Both were the user's to set and cannot be inferred.
3. **Hand off to the verify-release skill immediately.** Publishing starts the Release and Publish
Docs workflows in parallel at that moment; verification that begins late misses them mid-flight.
If the user reports publishing but the API still shows a draft, trust the API and say so — an
unsaved draft looks identical to a published release from the browser.
## Edge Cases
- **No new PRs since preparation**: proceed normally — the prepare-release notes are used as the foundation with no warnings
@ -129,18 +225,23 @@ When the user requests revisions after the initial creation, always rewrite the
- **PR spans categories**: categorize by primary intent
- **Copilot timeline missing**: fall back to `Co-authored-by` trailers to determine whether `@Copilot` should be a co-author; if still unclear, use `@Copilot` as primary author
- **No breaking changes**: omit the Breaking Changes section entirely
- **Versioning link carried over from the prepare-release draft**: the draft may contain an unslugged or wrong-MAJOR versioning link. Correct it to the `v{MAJOR}` slug of the version being released before the draft release is created.
- **Versioning link for a brand-new MAJOR**: the `/v{MAJOR}/versioning.html` path is created by the Publish Docs workflow when the release is published. It is expected to 404 until then; use the slugged form regardless.
- **Single breaking change**: use the same numbered format as multiple
- **Draft edited but not published**: the user is still reviewing, and may be removing the AI disclosure. Take no action and do not reintroduce anything they removed
- **Draft disappears without a published release**: it may have been deleted, or published under a different tag. Check for a published release before assuming it was abandoned, then ask
- **Published tag differs from the prepared version**: stop and confirm with the user before verifying. Verifying the wrong version is worse than not verifying
## Release Notes Template
Omit empty sections. The preamble is **always required** — it is not inside a section heading. Tags may include prerelease suffixes, such as `v2.0.0-preview.1`, and Full Changelog compare links should use the exact tag.
Omit empty sections. The preamble is **always required** — it is not inside a section heading. Tags may include prerelease suffixes, such as `v2.0.0-preview.1`, and Full Changelog compare links should use the exact tag. The versioning link uses the `v{MAJOR}` slug for the version being released — see [release-branches.md](../shared-resources/release-branches.md#versioning-documentation-links).
```markdown
[Preamble — REQUIRED. Summarize the release theme.]
## Breaking Changes
Refer to the [C# SDK Versioning](https://csharp.sdk.modelcontextprotocol.io/versioning.html) documentation for details on versioning and breaking change policies.
Refer to the [C# SDK Versioning](https://csharp.sdk.modelcontextprotocol.io/v{MAJOR}/versioning.html) documentation for details on versioning and breaking change policies.
1. **Description #PR**
* Detail of the break

View file

@ -27,7 +27,7 @@ When the user requests changes to existing release notes:
1. Fetch the current release body and save it to a local file
2. **Breaking change audit**: Run the full breaking-changes skill audit on the commit range, just as for new release notes — this includes examining PRs, reconciling labels, offering to comment on PRs, and getting user confirmation. Also extract any breaking changes already documented in the existing release body; these must be preserved and reconciled with the audit results.
3. **Preamble check**: Verify the release has a preamble (text before the first `##` heading). If missing, compose one. The versioning documentation link belongs under the `## Breaking Changes` heading, not in the preamble.
3. **Preamble check**: Verify the release has a preamble (text before the first `##` heading). If missing, compose one. The versioning documentation link belongs under the `## Breaking Changes` heading, not in the preamble, and must use the `v{MAJOR}` slug for the released version — see [release-branches.md](../../shared-resources/release-branches.md#versioning-documentation-links).
4. Write the **entire** corrected body to a separate local file (ensuring proper line breaks between all sections, entries, and paragraphs)
5. Run `git diff --no-index` between the original and updated files and **always** present the raw diff output directly in the response as a fenced code block with `diff` syntax highlighting. Do not summarize or paraphrase the diff — always show the complete diff to the user. Require explicit confirmation before uploading. For published releases (not drafts), also offer to save the original body to a permanent local file, noting that GitHub does not retain prior versions of release notes.
6. Upload the complete file using `gh release edit --notes-file <file>`
@ -47,8 +47,25 @@ After every release body update:
- [ ] Preamble exists before the first `##` heading
- [ ] If `## Breaking Changes` section exists, it begins with the versioning docs link paragraph before the numbered list
- [ ] The versioning docs link uses the `v{MAJOR}` slug for the released version (e.g. `/v2/versioning.html`), never the unslugged `/versioning.html`
- [ ] Line count matches expected structure (~80+ lines for a typical release)
- [ ] Section headings (`## Breaking Changes`, `## What's Changed`, etc.) each appear on their own line
- [ ] Bullet entries are each on their own line
- [ ] No stray characters at the start of the body
- [ ] Preview the release on GitHub to confirm rendering
## AI Disclosure
A draft release body created by an agent carries a concise AI-generated disclosure at the bottom:
```markdown
> [!NOTE]
> These release notes were drafted with GitHub Copilot and reviewed before publishing.
```
Keep it on the draft. Removing it is the **user's** decision, made as part of their final sign-off
once they have reviewed the notes line by line and are satisfied the content is theirs. Never remove
it on your own initiative, and never reintroduce it after the user has removed it.
This exception applies only to release notes, which get a dedicated human review before publishing.
Disclosures on pull request descriptions, issues, and comments always remain.

View file

@ -0,0 +1,76 @@
---
name: run-conformance-from-branch
description: Run MCP conformance tests in the C# SDK against a conformance branch (including forks) instead of the published npm version, then restore pinned dependencies.
compatibility: Requires npm, node, and dotnet SDK. Uses the csharp-sdk repo package.json/package-lock.json and tests/ModelContextProtocol.AspNetCore.Tests.
---
# Run Conformance From Branch
Run C# SDK conformance tests against an unpublished `modelcontextprotocol/conformance` branch (including branches in forks).
## Use Cases
- Validate a conformance PR before it is published to npm
- Validate C# SDK behavior against a fork with custom scenario changes
- Reproduce failures caused by conformance changes
## Safety / Repo Hygiene
1. Start from a clean git state.
2. Commit or stash local changes first.
3. Restore pinned dependencies when done (`npm ci`).
## Inputs
- **Source type**: `upstream-branch` or `fork-branch`
- **Source locator**:
- Upstream branch: `modelcontextprotocol/conformance#<branch>`
- Fork branch: `<owner>/conformance#<branch>`
- **Scenario** (optional): e.g. `auth/scope-step-up`
## Workflows
### A) Install directly from GitHub branch (upstream or fork)
From `csharp-sdk` root:
```bash
npm install --no-save @modelcontextprotocol/conformance@github:<owner>/conformance#<branch>
```
Examples:
```bash
npm install --no-save @modelcontextprotocol/conformance@github:modelcontextprotocol/conformance#main
npm install --no-save @modelcontextprotocol/conformance@github:myuser/conformance#sep-2350-check
```
## Run Tests
### Run client conformance tests with dotnet test filter:
```bash
dotnet test tests/ModelContextProtocol.AspNetCore.Tests/ModelContextProtocol.AspNetCore.Tests.csproj -f net10.0 --filter "FullyQualifiedName~ClientConformanceTests"
```
### Run server conformance tests with dotnet test filter:
```bash
dotnet test tests/ModelContextProtocol.AspNetCore.Tests/ModelContextProtocol.AspNetCore.Tests.csproj -f net10.0 --filter "FullyQualifiedName~ServerConformanceTests"
```
## Reporting
Always report:
1. Installed conformance source (`npm ls @modelcontextprotocol/conformance --depth=0`)
2. Scenario results (pass/fail/warnings)
3. Any new check IDs observed (for traceability)
## Cleanup / Restore
Return repo to pinned dependency state:
```bash
npm ci
```

View file

@ -25,12 +25,61 @@ Official NuGet.org publishes happen only when a GitHub Release is created from a
## Previous-release tag lookup
- On `main`: most recent published release globally (use `gh release list --exclude-drafts --limit 50` and pick the highest semver). No MAJOR filter.
- On `release/{MAJOR}.x`: most recent published release whose tag matches `v{MAJOR}.*`. Drafts are excluded.
Select the **highest semver** among published releases that are **ancestors of the target commit**,
excluding drafts:
```sh
gh release list --exclude-drafts --limit 50
```
- On `main`: no MAJOR filter — the highest semver ancestor wins.
- On `release/{MAJOR}.x`: restrict candidates to tags matching `v{MAJOR}.*`.
**"Highest semver" and "most recent by date" are not the same rule, and the difference is not
hypothetical.** Ship `v2.1.0` from `main`, then a `v2.0.1` servicing patch from `release/2.0.x`, and
the most recently *published* release is `v2.0.1` while the highest semver is `v2.1.0`. Ordering by
date picks a tag that is not on `main` at all, which produces a bogus PR range and makes ApiCompat
report the entire API surface as removed. Order by version, not by publication time.
The ancestry constraint is what makes this safe across branches, so verify it rather than assuming
the version ordering implied it — a tag can be both the highest semver and unreachable from the
target. `prepare-release` Step 2 performs this check explicitly.
This is purely a baseline-selection rule. It does **not** change the breaking-change policy. See [the versioning docs](https://csharp.sdk.modelcontextprotocol.io/versioning.html) for the policy.
## Work-branch naming
## Versioning documentation links
The documentation site is published per major version under a `v{MAJOR}` slug (`/v1/`, `/v2/`). Any
link to the versioning documentation from **release notes** — both the release-notes link and the
paragraph under the `## Breaking Changes` heading — must point at the slugged instance for the
version being released:
```
https://csharp.sdk.modelcontextprotocol.io/v{MAJOR}/versioning.html
```
The slug is derived from the **MAJOR component of the version being released**, not from the branch:
| Version being released | Versioning link |
| ---------------------- | --------------- |
| `1.3.1` | `https://csharp.sdk.modelcontextprotocol.io/v1/versioning.html` |
| `2.0.0-preview.1` | `https://csharp.sdk.modelcontextprotocol.io/v2/versioning.html` |
| `2.0.0` | `https://csharp.sdk.modelcontextprotocol.io/v2/versioning.html` |
The branch is normally consistent with this — `release/1.x` releases `1.x` versions and `main`
currently releases `2.x` — but the version is what determines the slug. If a release's MAJOR ever
disagrees with its branch's MAJOR, follow the version.
Prerelease suffixes do not affect the slug: `2.0.0-preview.1` and `2.0.0` both use `/v2/`.
The unslugged `https://csharp.sdk.modelcontextprotocol.io/versioning.html` redirects to the site's
default version, which tracks the newest release. It is therefore unstable for a published release's
notes — a later MAJOR would silently repoint it. Never use the unslugged form in release notes.
**First release of a new MAJOR**: the `/v{MAJOR}/` path does not exist until the Publish Docs
workflow runs, which happens when the GitHub release is published. The link is forward-referencing
at prepare and publish time, exactly like the release-notes tag link, and resolves once the release
is published. The **verify-release** skill confirms it.
Prepare-release work branches are named `release-{version}` (flat, hyphen-separated):
- `release-2.0.0-preview.1`

197
.github/skills/verify-release/SKILL.md vendored Normal file
View file

@ -0,0 +1,197 @@
---
name: verify-release
description: Verify a published release of the C# MCP SDK. Monitors the Release and Publish Docs workflows triggered by publishing a GitHub release, confirms the packages are listed on NuGet.org, and confirms the versioned documentation site reflects the release. Use when asked to verify a release, check whether a release published correctly, monitor the release or docs workflow, confirm packages on NuGet, or check whether the docs site updated.
compatibility: Requires gh CLI with repo access for workflow runs and releases, and network access to nuget.org and csharp.sdk.modelcontextprotocol.io.
---
# Verify Release
Verify that a published release of `modelcontextprotocol/csharp-sdk` fully shipped. Publishing a
GitHub release triggers **two workflows in parallel**, and the release is not done until both have
succeeded and both of their outputs are confirmed live.
| Workflow | File | Trigger | Produces |
|---|---|---|---|
| Release | [`.github/workflows/release.yml`](../../workflows/release.yml) | `release: published` | NuGet packages published to NuGet.org |
| Publish Docs | [`.github/workflows/docs.yml`](../../workflows/docs.yml) | `release: published` | The versioned docs site at <https://csharp.sdk.modelcontextprotocol.io> |
Use the shared [release branch reference](../shared-resources/release-branches.md) for branch roles
and release tag conventions.
> **Safety: This skill is read-only by default.** It inspects workflow runs, releases, and published
> artifacts. The only actions it may take are re-running a failed workflow or dispatching a docs
> refresh, and both require explicit user confirmation.
## Process
Work through each step sequentially. Present findings at each step and get user confirmation before
taking any action.
### Step 1: Identify the Release
The user may provide:
- **A version or tag** (e.g., `2.0.0-preview.1`, `v1.3.1`) — use directly
- **No context** — list recent releases with `gh release list --limit 10` and ask the user to select
Confirm the release is **published**, not a draft:
```
gh release view {tag} --json tagName,isDraft,isPrerelease,publishedAt,targetCommitish,url
```
If the release is still a draft, **stop**. Neither workflow has run — nothing is published, and no
verification is possible. Tell the user the draft must be published in the GitHub UI first, and
that publishing is a deliberate human action this skill will not perform.
Record the tag, the published timestamp, and the target commitish for the following steps.
### Step 2: Locate Both Workflow Runs
Find the runs triggered by publishing this release. A release-event run carries the **tag name in
`headBranch`**, which is an exact identifier — use it rather than correlating on timestamps:
```
gh run list --workflow release.yml --event release --branch v{version} --limit 5 --json databaseId,status,conclusion,headBranch,headSha,createdAt,url
gh run list --workflow docs.yml --event release --branch v{version} --limit 5 --json databaseId,status,conclusion,headBranch,headSha,createdAt,url
```
**Do not identify runs by "the most recent run" or "created at or after `publishedAt`."** Those
match any release published in the same window, so a concurrent or closely-following release —
including a servicing patch published from another branch minutes later — can be reported as this
release's result, showing a green run for the wrong tag. Confirm `headBranch` equals `v{version}`
on every run before evaluating it.
Cross-check `headSha` against the release's target commitish recorded in Step 1. A mismatch means
the tag moved between drafting and publishing, and the run validated something other than what was
reviewed — stop and report it rather than evaluating the run.
If more than one run matches the tag, the workflow was re-run; evaluate the **latest attempt** and
say that earlier attempts existed rather than silently reporting only the newest.
Present both runs with their status, conclusion, and URL. Watch them **together** — they run
concurrently and either can fail independently. Do not report success for the release until both
are accounted for.
If a run cannot be found for either workflow, report which one is missing and check whether the
workflow is disabled or whether its `if` repository guard excluded the run (both workflows only run
in the `modelcontextprotocol/csharp-sdk` repository, not in forks).
### Step 3: Evaluate the Release Workflow
Report the run's conclusion. If it failed, identify the failing job and step and summarize the
error:
```
gh run view {run-id} --log-failed
```
A failure here does **not** roll back the release — the GitHub release and its tag remain, and the
workflow is simply re-run once the cause is addressed. Re-running is safe and is usually the right
first move. Recommend it, but **do not re-run without explicit user confirmation**.
> **Never run `dotnet nuget push` and never handle NuGet API keys.** Package publishing happens only
> through the workflow.
### Step 4: Evaluate the Publish Docs Workflow
Report the run's conclusion, accounting for these docs-specific behaviors:
- **Superseded runs are not failures.** The workflow uses a `pages` concurrency group with
`cancel-in-progress: true`. Every run rediscovers the current releases and rebuilds the whole site
from scratch, so a newer run fully supersedes the one it cancels. Report a cancelled run as
*superseded* and follow the newer run instead.
- **Version discovery reads published releases.** For each major version >= 1, the workflow takes
the most recently published non-draft release tagged `v{MAJOR}.*`. A draft release contributes
nothing.
- **Every major is rebuilt.** A release-triggered run builds each major from its latest release tag
into its own path (`/v1/`, `/v2/`). A manual dispatch defaults to the same release-tag content,
or can build every major from `release/{MAJOR}.x`, using `main` for its matching major,
by selecting `docs_source=latest-branches`. A new MAJOR adds a new path; the site root redirects
to the newest release, prereleases included.
- **Orchestration comes from `main`.** The scripts and picker assets are always checked out from
`main`. Release-triggered and default manual runs use release-tag content; a manual
`docs_source=latest-branches` run uses source-branch content. A docs fix that lives only in a
release branch will not affect orchestration.
If it failed, summarize the failing step. Common causes are a docs build failure in one version's
worktree (`make generate-docs`) or a Pages deployment error.
### Step 5: Confirm the Published Packages
Confirm the exact released version is listed for each shipping package on NuGet.org.
Listing can lag a successful workflow run by several minutes. If the workflow succeeded but the
version is not yet visible, say so explicitly and offer to re-check — **do not report this as a
failure**. Distinguish "published but not yet indexed" from "not published."
Report each package with its status, and flag any shipping package missing from the release.
### Step 6: Confirm the Documentation Site
Confirm <https://csharp.sdk.modelcontextprotocol.io> reflects this release:
1. **Version path** — the major-version path for this release (for example `/v2/`) is live and
serving the new content.
2. **Version picker** — the picker offers this release's major version.
3. **Root redirect** — the site root redirects to the expected default version, which is the newest
release by publish date, prereleases included.
4. **Versioning page** — the slugged versioning page for this release,
`https://csharp.sdk.modelcontextprotocol.io/v{MAJOR}/versioning.html`, resolves. Release notes
link to it from the Breaking Changes section, and for the first release of a new MAJOR that path
only comes into existence with this workflow run. Confirm the release notes use the slugged form
and not the unslugged `/versioning.html`, which tracks the site default and can silently repoint
when a later MAJOR ships.
GitHub Pages caches aggressively, so a short delay after a successful deploy is normal.
Distinguish "deployed but not yet propagated" from "deployed wrong."
### Step 7: Report
Summarize the verification as a table covering both workflows and both published outputs, and state
plainly whether the release is fully verified or what remains outstanding.
| Check | Status |
|---|---|
| Release workflow | ✅ succeeded — {run URL} |
| Publish Docs workflow | ✅ succeeded — {run URL} |
| Packages on NuGet.org | ✅ {version} listed for all N packages |
| Docs site | ✅ `/v2/` live, picker updated, root redirects |
## Remediation
Both remediations require explicit user confirmation.
**Re-run a failed workflow:**
```
gh run rerun {run-id} --failed
```
**Rebuild the released docs** — use the default `release-tags` source to retry a failed Pages
deployment after a release, without minting a product release:
```
gh workflow run docs.yml --field docs_source=release-tags
```
**Refresh docs without a new release** — select `latest-branches` to rebuild every published major
from its current source branch (`release/{MAJOR}.x`, using `main` for its matching major):
```
gh workflow run docs.yml --field docs_source=latest-branches
```
The workflow fails instead of silently using a release tag when any major has no matching branch.
## Edge Cases
- **Release is still a draft** — stop; neither workflow has run. The user must publish in the GitHub UI.
- **Docs run cancelled** — expected under the `pages` concurrency group; report as superseded and follow the newer run.
- **Only one workflow ran** — check whether the other is disabled, or whether the repository guard excluded it (forks do not run either workflow).
- **Workflow succeeded but NuGet version not listed** — indexing lag; re-check before reporting a failure.
- **Workflow succeeded but docs not visible** — Pages caching; re-check before reporting a failure.
- **Docs site missing the new major version** — confirm the release is published and non-draft, then confirm the tag matches `v{MAJOR}.*`.
- **Root redirects to an unexpected version** — the default is the newest release *by publish date*, including prereleases. A prerelease published after a stable release becomes the default; this is by design.
- **Release workflow failed after partial publish** — some packages may already be on NuGet.org. NuGet versions cannot be unpublished; re-running skips already-published versions. Report exactly which packages are listed before recommending a re-run.
- **Versioning link is unslugged or points at the wrong MAJOR** — release notes must link to `/v{MAJOR}/versioning.html` for the released version. Report it so the user can correct the body; the unslugged form tracks the site default and will repoint when a later MAJOR ships.
- **Verifying an older release** — the docs workflow only ever reflects each major's *latest* release, so an older release's docs path will have been overwritten by a newer one. Verify packages only and note this.

Some files were not shown because too many files have changed in this diff Show more