docs: add prose documentation for core features to meet conformance#702
Draft
docs: add prose documentation for core features to meet conformance#702
Conversation
25e9f72 to
f51f6f2
Compare
f51f6f2 to
2ec785f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #692
Motivation and Context
Add prose documentation for 8 core MCP features to meet the Tier 2 SDK conformance requirement. All 8 features are already fully implemented but lack prose documentation. This PR adds a single
docs/FEATURES.mdcovering each feature with server-side and client-side code examples, notification patterns, and links to runnable examples and the MCP spec.Features documented: Resources, Prompts, Sampling, Roots, Logging, Completions, Notifications, Subscriptions.
Each section follows a consistent structure: overview, server-side implementation, client-side usage, notifications/change handling, and links to examples and spec. The approach is a hybrid of patterns from existing Tier 1 SDKs:
docs/server.md) - single-file structure, short descriptions with code examples and linksREADME.md) - inline documentation with decorator-based examplesdocs/concepts/<feature>/) - most thorough, with separate server/client coverage and change notification patternsHow Has This Been Tested?
Breaking Changes
None. Documentation only.
Types of changes
Checklist
Additional context