docs: document session management for streamable HTTP transport#674
Draft
DaleSeo wants to merge 1 commit intomodelcontextprotocol:mainfrom
Draft
docs: document session management for streamable HTTP transport#674DaleSeo wants to merge 1 commit intomodelcontextprotocol:mainfrom
DaleSeo wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
b1d7e60 to
cdedffd
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.
Motivation and Context
The
SessionManagertrait and theStreamableHttpServiceare key to how MCP servers manage stateful sessions over Streamable HTTP. However, the current documentation is lacking. There's no overview of the module, no explanation of what a "session" means here, and no examples on how to read the session ID or custom state in a tool handler.This PR adds rustdoc documentation to close that gap.
How Has This Been Tested?
Documentation-only change. Verified that
cargo docbuilds without warnings and all existing tests continue to pass.Breaking Changes
None.
Types of changes
Checklist
Additional context