feat(core): Add support for map parameter type #324
+194
−11
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
anubhav756
requested review from
kurtisvg,
dishaprakash,
twishabansal and
duwenxin99
This PR introduces support for the `map` parameter type in the Python SDKs, aligning it with the recent MCP Toolbox server enhancements ([#928](googleapis/genai-toolbox#928)). This allows tools to define parameters that are key-value pairs, either as a generic map with mixed-type values or as a strictly typed map. * The `ParameterSchema` in `protocol.py` has been updated to include an optional `valueType` field. * The internal `__get_type` method now correctly resolves the `map` type to the appropriate Python `dict` type hint: * `dict[str, Any]` for generic maps (when `valueType` is omitted). * `dict[str, <type>]` for typed maps (e.g., `dict[str, str]`, `dict[str, int]`). * Added extensive unit tests to `test_protocol.py` to ensure the `map` type is handled correctly. * Test coverage includes: * Generic (untyped) maps. * Typed maps for `string`, `integer`, `float`, and `boolean`. * Optional maps. * Error handling for unsupported `valueType`. > [!NOTE] > No modifications were required in `toolbox-langchain` or `toolbox-llamaindex`. They inherit this new functionality directly from `toolbox-core`.
kurtisvg
previously approved these changes
Aug 2, 2025
1 task
|
/gcbrun |
|
/gcbrun |
2 similar comments
|
/gcbrun |
|
/gcbrun |
twishabansal
reviewed
Aug 6, 2025
| @@ -44,6 +45,12 @@ def __get_type(self) -> Type: | |||
| if self.items is None: | |||
| raise ValueError("Unexpected value: type is 'array' but items is None") | |||
| base_type = list[self.items.__get_type()] # type: ignore | |||
| elif self.type == "object": | |||
There was a problem hiding this comment.
nit: Should this be a map type parameter?
There was a problem hiding this comment.
In the manifest the type is returned as a object.
CC: @duwenxin99
There was a problem hiding this comment.
@duwenxin99 are there specific reasons for using different manifest and object types in the server and client?
There was a problem hiding this comment.
(Unresolving this comment for now)
There was a problem hiding this comment.
There are two reasons:
- To keep it consistent as the MCP manifest. MCP uses JSON schema and it doesn't have a "map" type. We are basically using "object" type to achieve the map functionality.
- If we decide to add in the "object" type parameter in the future, we can reuse the current "map" code as they are basically the same structure.
Open to discussion on this @twishabansal , @anubhav756 we can change it for the server if that's easier on the SDK side.
There was a problem hiding this comment.
I'm just worried that in the config file, the user defines a map. However, during usage with SDK or debugging, the user would see an object. Seems like this might be a little confusing for the user. What do you folks think?
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.
Fixes #321
This PR introduces support for the
mapparameter type in the Python SDKs, aligning it with the recent MCP Toolbox server enhancements (#928). This allows tools to define parameters that are key-value pairs, either as a generic map with mixed-type values or as a strictly typed map.Changes
ParameterSchemainprotocol.pyhas been updated to include an optionalvalueTypefield.__get_typemethod now correctly resolves themaptype to the appropriate Pythondicttype hint:dict[str, Any]for generic maps (whenvalueTypeis omitted).dict[str, <type>]for typed maps (e.g.,dict[str, str],dict[str, int]).Testing
test_protocol.pyto ensure themaptype is handled correctly.string,integer,float, andboolean.valueType.Note
No modifications were required in
toolbox-langchainortoolbox-llamaindex. They inherit this new functionality directly fromtoolbox-core.