Skip to content

[Client] docs: introduce client SDK documentation and improve README structure#259

Merged
chr-hertel merged 3 commits intomodelcontextprotocol:mainfrom
CodeWithKyrian:docs/client-sdk-documentation
Mar 31, 2026
Merged

[Client] docs: introduce client SDK documentation and improve README structure#259
chr-hertel merged 3 commits intomodelcontextprotocol:mainfrom
CodeWithKyrian:docs/client-sdk-documentation

Conversation

@CodeWithKyrian
Copy link
Copy Markdown
Contributor

This PR introduces comprehensive documentation for the Client SDK, including detailed guides and examples. It also restructures the README to 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 README structure needed to change a bit to accommodate the Client SDK and for better flow.

What's Changed

  • Added comprehensive docs/client.md with full client SDK documentation
  • Updated docs/index.md to include client documentation link
  • Updated docs/examples.md with client example walkthroughs
  • Restructured README.md with clear Server SDK and Client SDK sections
  • Updated roadmap to mark "Implement Client component" as complete

- 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
@chr-hertel chr-hertel added the Client Issues & PRs related to the Client component label Mar 10, 2026
chr-hertel
chr-hertel previously approved these changes Mar 14, 2026
Copy link
Copy Markdown
Member

@chr-hertel chr-hertel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @CodeWithKyrian - only minor questions/proposals for README.md, up to you - i like the new version 👍

@chr-hertel chr-hertel added this to the 0.5.0 milestone Mar 30, 2026
Co-authored-by: Christopher Hertel <mail@christopher-hertel.de>
Co-authored-by: Christopher Hertel <mail@christopher-hertel.de>
Copy link
Copy Markdown
Member

@chr-hertel chr-hertel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @CodeWithKyrian!

@chr-hertel chr-hertel merged commit 85fddf5 into modelcontextprotocol:main Mar 31, 2026
17 checks passed
@chr-hertel chr-hertel added the documentation Improvements or additions to documentation label Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Client Issues & PRs related to the Client component documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants