fix: ensure object schemas always include required field for OpenAI compatibility#1696
Open
ctonneslan wants to merge 3 commits intomodelcontextprotocol:mainfrom
Open
fix: ensure object schemas always include required field for OpenAI compatibility#1696ctonneslan wants to merge 3 commits intomodelcontextprotocol:mainfrom
ctonneslan wants to merge 3 commits intomodelcontextprotocol:mainfrom
Conversation
…ompatibility
When using z.object({}).strict() as inputSchema, the generated JSON schema
omits the required field. OpenAI strict JSON schema mode requires required
to always be present (even as an empty array), causing tool registration
to fail with: "Schema must have the following keys: required"
Fixed in two places:
- schemaToJson() now adds required: [] to object schemas missing it
- EMPTY_OBJECT_JSON_SCHEMA constant now includes required: []
Fixes modelcontextprotocol#1659
🦋 Changeset detectedLatest commit: b4f1b45 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 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
1 participant
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.
Summary
When registering a tool with an empty Zod object (
z.object({}).strict()) asinputSchema, the generated JSON schema omits therequiredfield. OpenAI strict JSON schema mode requiresrequiredto always be present, causing:Changes
packages/core/src/util/schema.ts:schemaToJson()now checks if the output is an object type schema missingrequiredand addsrequired: [].packages/server/src/server/mcp.ts:EMPTY_OBJECT_JSON_SCHEMAconstant now includesrequired: [].Before/After
Before:
{ "type": "object", "properties": {} }After:
{ "type": "object", "properties": {}, "required": [] }Both are valid JSON Schema, but the latter is compatible with OpenAI strict mode.
Fixes #1659