[Client] docs: introduce client SDK documentation and improve README structure#259
Open
CodeWithKyrian wants to merge 1 commit intomodelcontextprotocol:mainfrom
Open
Conversation
- Create new client documentation with examples and API reference - Restructure README for better clarity and flow - Add client examples to documentation index - Update roadmap to mark client component as complete
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
2 participants
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.
This PR introduces comprehensive documentation for the Client SDK, including detailed guides and examples. It also restructures the
READMEto provide better clarity and flow for both server and client SDK usage.Context and Motivation
The Client SDK was recently implemented in #192 without any documentation. This PR addresses that gap by creating extensive documentation that covers all client features. Additionally, the
READMEstructure needed to change a bit to accommodate the Client SDK and for better flow.What's Changed
docs/client.mdwith full client SDK documentationdocs/index.mdto include client documentation linkdocs/examples.mdwith client example walkthroughsREADME.mdwith clear Server SDK and Client SDK sections