-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Resolve tool output-schema references within the schema document only #3394
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+39
−8
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 nit: This is a user-visible behaviour change — tool output schemas whose
$refs point outside the document (previously auto-fetched by jsonschema, so such tools worked) now makecall_toolraiseRuntimeError: Invalid schema for tool ...— but no page underdocs/is updated, and AGENTS.md requires docs updates for user-visible behaviour changes in the same PR.docs/advanced/low-level-server.md(the section documenting the client-side validationRuntimeError) ordocs/servers/structured-output.mdshould note that$refs resolve only within the schema document and how the failure surfaces.Extended reasoning...
The PR's own "Breaking Changes" section states that a result whose validation reaches a
$refoutside the schema document now fails withRuntimeError, and that a dangling in-document$refchanges exception type from areferencingerror toRuntimeError. On the base branch, jsonschema's default registry auto-retrieves remote/file$refs (with a DeprecationWarning), so a tool declaring e.g.{"$ref": "https://example.com/schema.json"}validated successfully; after merge the same tool's everycall_toolraisesRuntimeError. AGENTS.md ("Documentation") says: "When a change affects public API or user-visible behaviour, update the relevant page(s) under docs/ in the same PR." The diff touches only src/mcp/client/session.py and tests/client/test_output_schema_validation.py; no docs file changes. docs/advanced/low-level-server.md:112 is the existing page documenting the client-sideRuntimeErrorvalidation contract that users upgrading will consult when their external-$ref tools start failing, and it says nothing about$refresolution scope. A correct fix adds a shoVerification: nit. The diff touches only
src/mcp/client/session.pyandtests/client/test_output_schema_validation.py(verified viagit diff e7284ed..HEAD --name-only) — no file underdocs/is updated. AGENTS.md (applicable per scope) states: "When a change affects public API or user-visible behaviour, update the relevant page(s) underdocs/in the same PR." The change is user-visible: at src/mcp/cli