docs: add troubleshooting and migration guidance for Zod schema shape differences - #2870
Open
diveshs0801 wants to merge 1 commit into
Open
diveshs0801 wants to merge 1 commit into
diveshs0801 wants to merge 1 commit into
Conversation
Clarify difference between Zod raw shapes and ZodObject across SDK v1 and v2, addressing silent empty inputSchema and tools/list crashes. Fixes modelcontextprotocol#2627
|
@modelcontextprotocol/client
@modelcontextprotocol/codemod
@modelcontextprotocol/core
@modelcontextprotocol/server
@modelcontextprotocol/server-legacy
@modelcontextprotocol/express
@modelcontextprotocol/fastify
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
This branch has not been deployed
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
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.
Clarify difference between Zod raw shapes and ZodObject across SDK v1 and v2, addressing silent empty inputSchema and tools/list crashes.
Fixes #2627
Motivation and Context
On SDK v1, passing
z.object({...})where a raw Zod shape ({ field: z.string() }) is expected leads to two failure modes:server.tool(...)withz.object({...})publishes an empty schema ({"type":"object"}) with no properties, causing clients to silently strip tool arguments.tools/list(v1 ≤ 1.21.0): CallingregisterToolwithz.object({...})causestools/listto fail withCannot read properties of null (reading '_def').Neither
docs/troubleshooting.mdnordocs/migration/upgrade-to-v2.mdpreviously documented this pitfall. This PR adds a dedicated troubleshooting entry with side-by-side code snippets and a warning callout in the v2 migration guide to save developers hours of debugging.How Has This Been Tested?
docs/troubleshooting.mdanddocs/migration/upgrade-to-v2.md.Breaking Changes
None. This is a documentation-only update.
Types of changes
Checklist
Additional context
Resolves #2627.