Document container limitations for Image/Audio/File objects #2118
Conversation
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
Adds warning in tools documentation clarifying that Image, Audio, and File helper objects cannot be nested in dictionaries or other containers. They must be returned directly or in top-level lists/tuples. Provides clear examples of what works vs what doesn't, and offers alternatives using MCP native types or ToolResult for complex scenarios. Closes #2115
jlowin
added
the
enhancement
marvin-context-protocol
bot
added
documentation
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.
This PR addresses issue #2115 by clarifying the documentation around how
Image,Audio, andFilehelper objects can be returned from tools.The current behavior is intentional: these helper objects are only converted to MCP content blocks when returned directly or in a top-level list/tuple. They cannot be nested inside dictionaries or other containers.
Closes #2115