Skip to content

README refactor #1197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Dec 1, 2025
Merged

README refactor #1197

merged 5 commits into from
Dec 1, 2025
+486 −1,793

Conversation

@KKonstantinov
Copy link
Contributor

@KKonstantinov KKonstantinov commented Dec 1, 2025

Refactor README.md into multiple files under docs/. Remove examples from README in favour of referencing src/examples examples which are being kept up to date and undergo typechecks / lint checks.

Motivation and Context

Keeping duplicate examples in the main README.md has proven a bit unreliable - examples get stale from time to time, and the README has become too long.

How Has This Been Tested?

Breaking Changes

None

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 1, 2025 •
edited
Loading

Open in StackBlitz

npm i https://pkg.pr.new/modelcontextprotocol/typescript-sdk/@modelcontextprotocol/sdk@1197

commit: 0fd3e26

@KKonstantinov KKonstantinov marked this pull request as ready for review December 1, 2025 11:29
@KKonstantinov KKonstantinov requested a review from a team as a code owner December 1, 2025 11:29
mattzcarey
mattzcarey reviewed Dec 1, 2025
View reviewed changes
docs/faq.md

### Why do I see `TS2589: Type instantiation is excessively deep and possibly infinite` after upgrading the SDK?

This TypeScript error can appear when upgrading to newer SDK versions that support Zod v4 (for example, from `@modelcontextprotocol/sdk` `1.22.0` to `1.23.0`) **and** your project ends up with multiple `zod` versions in the dependency tree.
Copy link
Contributor

@mattzcarey mattzcarey Dec 1, 2025

Choose a reason for hiding this comment

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

amazing

mattzcarey
mattzcarey approved these changes Dec 1, 2025
View reviewed changes
Copy link
Contributor

@mattzcarey mattzcarey left a comment

Choose a reason for hiding this comment

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

Awesome stuff

@KKonstantinov KKonstantinov merged commit 74ab69f into modelcontextprotocol:main Dec 1, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattzcarey mattzcarey mattzcarey approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@KKonstantinov @mattzcarey