README refactor#1197
Merged
KKonstantinov merged 5 commits intoDec 1, 2025
Merged
Conversation
commit: |
KKonstantinov
marked this pull request as ready for review
December 1, 2025 11:29
mattzcarey
reviewed
Dec 1, 2025
|
|
||
| ### 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. |
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.
Refactor
README.mdinto multiple files underdocs/. Remove examples from README in favour of referencingsrc/examplesexamples which are being kept up to date and undergo typechecks / lint checks.Motivation and Context
Keeping duplicate examples in the main
README.mdhas 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
Checklist
Additional context