Skip to content

Commit 08999e2

Browse files
jeffhandleyeiriktsarpalismikekistler
authored
Apply suggestions from reviews
Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
1 parent 9efdf2a commit 08999e2

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ items:
33
href: concepts/index.md
44
- name: API Reference
55
href: api/ModelContextProtocol.yml
6-
- name: C# SDK Versioning
6+
- name: Versioning
77
href: versioning.md
88
- name: GitHub
99
href: https://github.com/ModelContextProtocol/csharp-sdk

docs/versioning.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: jeffhandley
44
description: ModelContextProtocol C# SDK approach to versioning, breaking changes, and support
55
uid: versioning
66
---
7-
The ModelContextProtocol specification continues to evolve rapidly, and it's important for the C# SDK to remain current with specification additions and updates. To enable this, all NuGet packages that compose the SDK will follow [Semantic Versioning](https://semver.org) with MAJOR.MINOR.PATCH version numbers, and optional pre-release versions.
7+
The ModelContextProtocol specification continues to evolve rapidly, and it's important for the C# SDK to remain current with specification additions and updates. To enable this, all NuGet packages that compose the SDK will follow [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) with MAJOR.MINOR.PATCH version numbers, and optional pre-release versions.
88

99
Given a version number MAJOR.MINOR.PATCH, the package versions will increment the:
1010

@@ -31,11 +31,11 @@ Beginning with the 1.0.0 release, the following support policy will be applied f
3131

3232
MAJOR or MINOR version updates might introduce or alter APIs annotated as [`[Experimental]`](https://learn.microsoft.com/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute). This attribute indicates that an API is experimental and it may change at any time--including within PATCH or MINOR version updates.
3333

34-
Experimental APIs require suppression of diagnostic codes specific to the MCP SDK APIs.
34+
Experimental APIs require suppression of diagnostic codes specific to the MCP SDK APIs, using an `MCPEXP` prefix.
3535

3636
## Breaking changes
3737

38-
Prior to the release of a stable 1.0.0 set of NuGet packages, the SDK remains in preview and breaking changes can be introduced without prior notice. All versions beginning with the stable 1.0.0 release will follow semantic versioning. Bugs will be fixed in PATCH versions; new APIs will be added in MINOR versions, and breaking changes will require increments to the MAJOR version.
38+
Prior to the release of a stable 1.0.0 set of NuGet packages, the SDK remains in preview and breaking changes can be introduced without prior notice. All versions beginning with the stable 1.0.0 release will follow semantic versioning, and breaking changes will require increments to the MAJOR version.
3939

4040
If feasible, the SDK will support all versions of the MCP spec. However, if breaking changes to the spec make this infeasible, preference will be given to the most recent version of the MCP spec, and this would be considered a breaking change necessitating a new MAJOR version.
4141

@@ -58,4 +58,4 @@ If APIs within the SDK become obsolete due to changes in the MCP spec or other e
5858
2. Within a MAJOR version update, APIs may be marked as `[Obsolete]` to produce _build errors_ indicating the API is no longer functional and always throws exceptions. The build errors will provide guidance specific to the affected APIs.
5959
3. Within a MAJOR version update, obsolete APIs may be removed. API removals are expected to be rare and avoided wherever possible, and `[Obsolete]` attributes will be applied ahead of the API removal.
6060

61-
Beginning with the 1.0.0 release, all obsoletions will use diagnostic codes specific to the MCP SDK APIs.
61+
Beginning with the 1.0.0 release, all obsoletions will use diagnostic codes specific to the MCP SDK APIs, using an `MCPOBS` prefix.

0 commit comments

Comments
 (0)