fix: do not omitempty ReadOnlyHint in ToolAnnotations#908
Open
pvlbzn wants to merge 3 commits intomodelcontextprotocol:mainfrom
Open
fix: do not omitempty ReadOnlyHint in ToolAnnotations#908pvlbzn wants to merge 3 commits intomodelcontextprotocol:mainfrom
omitempty ReadOnlyHint in ToolAnnotations#908pvlbzn wants to merge 3 commits intomodelcontextprotocol:mainfrom
Conversation
ReadOnlyHint is a bare bool with omitempty, so the zero value (false) is indistinguishable from unset and drops out of marshaled JSON. Consumers that explicitly set ReadOnlyHint: false on write tools lose the field on the wire. Removing omitempty ensures false is always serialized, which matches the MCP spec default. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
what do you think about removing the omitempty from here as well, to keep it consistent?
Author
There was a problem hiding this comment.
Yes, great take. This enables us to have symmetry: *bool are with omitempty since *bool is a ternary here, and bool are without omitempty, defaulting to false.
Contributor
|
I would also suggest adding a new point to |
Author
|
Thanks for the review and suggestions @maciej-kisiel @guglielmo-san. Updated the branch 👍 |
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
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.
ReadOnlyHintis aboolwith omitempty, so the zero value (false) is indistinguishable from unset, and drops out of marshaled JSON.The current behavior causes an issue with the OpenAI MCP app submission because they require explicit hints.
Consumers that explicitly set
ReadOnlyHint: falseon write tools lose the field on the wire. Removingomitemptyensuresfalseis always serialized, which matches the MCP spec default.