fix: ensure tool inputSchema includes type: object for discriminated unions#1675
Open
MayCXC wants to merge 2 commits intomodelcontextprotocol:mainfrom
Open
fix: ensure tool inputSchema includes type: object for discriminated unions#1675MayCXC wants to merge 2 commits intomodelcontextprotocol:mainfrom
MayCXC wants to merge 2 commits intomodelcontextprotocol:mainfrom
Conversation
…od schemas
z.toJSONSchema() on z.discriminatedUnion() produces { oneOf: [...] }
without a top-level type field. The MCP protocol requires
inputSchema.type === "object" (spec.types.ts), so clients that
validate the tools/list response reject discriminated union schemas.
Since discriminated unions are always unions of object types (each
variant shares a discriminator key), type: "object" is semantically
correct at the top level. Spreading it before the schema output
is a no-op for z.object() (already has type) and adds the required
field for unions, intersections, etc.
Fixes: modelcontextprotocol#1643
🦋 Changeset detectedLatest commit: c624fc7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
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.
Fixes #1643
Problem
z.toJSONSchema()on az.discriminatedUnion()produces{ oneOf: [...] }without a top-leveltypefield. The MCP protocol requiresinputSchema.type === "object"(spec.types.ts), so clients that validate thetools/listresponse reject these schemas. Theas Tool['inputSchema']cast hides the mismatch at compile time.Fix
Spreading
type: 'object'before the schema output is a no-op forz.object()(already hastype) and adds the required field for unions, intersections, etc. This is semantically correct because discriminated unions are always unions of object types (each variant shares a discriminator key).The result is valid JSON Schema that satisfies the protocol:
{ "type": "object", "oneOf": [ { "type": "object", "properties": { "type": { "const": "page" }, ... }, "required": ["type", "search"] }, { "type": "object", "properties": { "type": { "const": "quiz" }, ... }, "required": ["type", "search"] } ] }Why not other approaches
schemaToJson: too MCP-specific for a general utilitytype: "object"+oneOfis already valid JSON Schema