Add output_schema caveat to response limiting docs#3099
Merged
Conversation
Contributor
|
Caution Review failedThe pull request is closed. WalkthroughThis pull request adds a documentation note to the middleware documentation page explaining that truncating responses when a tool defines an output_schema may result in the output being a plain TextContent instead of the expected structured output. The note is positioned adjacent to the Response Limiting behavior documentation and its usage examples, with no changes to code or runtime behavior. Possibly related PRs
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
The new
ResponseLimitingMiddlewaretruncates oversized responses into a singleTextContentblock — which means if a tool declares anoutput_schema, the truncated result won't conform to it. This adds a note to the docs so users aren't surprised.Extends #3072