feat: zod v4 with backwards compatibility for v3.25+ #1040
+14,508
−2,221
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
Add transparent Zod v3/v4 compatibility to the MCP TypeScript SDK, allowing users to install and use either version without any code changes or configuration. This addresses the need for the SDK to support multiple major versions of Zod in user applications.
The SDK exports v4 schemas by default, but the compatibility layer detects the Zod version at runtime and routes all schema operations (parsing, JSON Schema conversion, schema construction) to the appropriate implementation.
Borrowed openai's idea to vendor zod-to-json-schema locally, can be removed if the lib author ever merges their PR.
How Has This Been Tested?
Install the published version and test in your own app:
npm i @socotra/modelcontextprotocol-sdk@next # or pnpm i @socotra/modelcontextprotocol-sdk@nextComprehensive Test Coverage
49 Test Suites | 1090 Tests (all passing)
User-facing APIs tested with both v3 and v4:
Internal utilities tested with v4 only:
Test Files Created
.v3.test.tsfiles demonstrating real Zod v3 usage patternstypes.jsBreaking Changes
None. This is purely additive:
Types of changes
Checklist
Additional context
Implementation Architecture
Compatibility Layer (
src/server/zod-compat.ts)isZ4Schema(),isZ4Object(),isZ3Object()safeParse(),safeParseAsync()objectFromShape(),normalizeObjectSchema()SchemaOutput<S>,SchemaInput<S>JSON Schema Routing (
src/server/zod-json-schema-compat.ts)Design Decisions