fix: improve Zod v4 optional schema detection #1232
Closed
+7
−5
Conversation
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
- Prioritize `isOptional()` method check in isSchemaOptional to support both Zod v3 and v4 consistently. - Add `typeName` check for Zod v4 internal definitions to correctly identify optional schemas. - Fixes an issue where optional tool arguments were incorrectly marked as required in the generated JSON schema.
commit: |
Contributor
|
do you have a repro of this issue? All tests were passing before and it doesnt look like you changed any |
Author
Thanks for the review! After investigating, I found that PR #1199 already fixed this issue. |
Contributor
|
Closing this. In any case, thanks for your effort to raise it anyway |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Motivation and Context
This PR fixes a compatibility issue with Zod v4 where optional schemas were incorrectly identified as required.
Specifically, isSchemaOptional in zod-compat.ts was failing to detect optional fields because it relied on internal properties that differ in Zod v4, causing optional tool arguments to be marked as
requiredin the generated JSON Schema.How Has This Been Tested?
I verified the fix by running the existing test suite (
npm test), specifically theshould support optional prompt argumentstest case in src/server/mcp.test.ts, which now passes correctly.I also manually verified that isSchemaOptional correctly returns
trueforz.string().optional()using Zod v4.Breaking Changes
None. This is a bug fix that improves compatibility.
Types of changes
Checklist