-
Notifications
You must be signed in to change notification settings - Fork 665
Fix $ref pointer resolution after output schema wrapping #1435
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
Open
weinong
wants to merge
2
commits into
modelcontextprotocol:main
Choose a base branch
from
weinong:fix/rewrite-ref-after-output-schema-wrapping
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+260
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -520,6 +520,11 @@ typeProperty.ValueKind is not JsonValueKind.String || | |
| ["required"] = new JsonArray { (JsonNode)"result" } | ||
| }; | ||
|
|
||
| // After wrapping, any internal $ref pointers that used absolute JSON Pointer | ||
| // paths (e.g., "#/items/..." or "#") are now invalid because the original schema | ||
| // has moved under "#/properties/result". Rewrite them to account for the new location. | ||
| RewriteRefPointers(schemaNode["properties"]!["result"]); | ||
|
|
||
| structuredOutputRequiresWrapping = true; | ||
| } | ||
|
|
||
|
|
@@ -529,6 +534,51 @@ typeProperty.ValueKind is not JsonValueKind.String || | |
| return outputSchema; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Recursively rewrites all <c>$ref</c> JSON Pointer values in the given node | ||
| /// to account for the schema having been wrapped under <c>properties.result</c>. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// <c>System.Text.Json</c>'s <see cref="System.Text.Json.Schema.JsonSchemaExporter"/> uses absolute | ||
| /// JSON Pointer paths (e.g., <c>#/items/properties/foo</c>) to deduplicate types that appear at | ||
| /// multiple locations in the schema. When the original schema is moved under | ||
| /// <c>#/properties/result</c> by the wrapping logic above, these pointers become unresolvable. | ||
| /// This method prepends <c>/properties/result</c> to every <c>$ref</c> that starts with <c>#/</c>, | ||
| /// and rewrites bare <c>#</c> (root self-references from recursive types) to <c>#/properties/result</c>, | ||
| /// so the pointers remain valid after wrapping. | ||
| /// </remarks> | ||
| private static void RewriteRefPointers(JsonNode? node) | ||
| { | ||
| if (node is JsonObject obj) | ||
| { | ||
| if (obj.TryGetPropertyValue("$ref", out JsonNode? refNode) && | ||
| refNode?.GetValue<string>() is string refValue) | ||
| { | ||
| if (refValue == "#") | ||
| { | ||
| obj["$ref"] = "#/properties/result"; | ||
| } | ||
| else if (refValue.StartsWith("#/", StringComparison.Ordinal)) | ||
| { | ||
| obj["$ref"] = "#/properties/result" + refValue.Substring(1); | ||
| } | ||
| } | ||
|
|
||
| // ToList() creates a snapshot because the $ref assignment above may invalidate the enumerator. | ||
| foreach (var property in obj.ToList()) | ||
| { | ||
| RewriteRefPointers(property.Value); | ||
| } | ||
| } | ||
| else if (node is JsonArray arr) | ||
| { | ||
| foreach (var item in arr) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why does the |
||
| { | ||
| RewriteRefPointers(item); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private JsonElement? CreateStructuredResponse(object? aiFunctionResult) | ||
| { | ||
| if (ProtocolTool.OutputSchema is null) | ||
|
|
||
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
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.
@stephentoub unless my knowledge of the stack is completely out of date, the encoding of method parameters as object properties happens at the AIFunctionFactory layer in Microsoft.Extensions.AI. Correspondingly, shouldn't this fix be applied in that library?
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.
Nevermind, I just realized this specifically applies to the transform happening literally a few lines above. I'm assuming we already do apply the same fixup in corresponding AIFunctionFactory locations?