-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Add helpers for converting FunctionTool and TransformedTool to SamplingTool #3062
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
Merged
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
9785b1e
Add helpers for converting FunctionTool and TransformedTool to Sampli…
github-actions[bot] a713df1
Merge branch 'main' into claude/issue-3021-20260203-0115
strawgate bcd1a53
Remove unnecessary inline imports and fix Any type hints
github-actions[bot] f898df2
Merge branch 'main' into claude/issue-3021-20260203-0115
strawgate cb83f00
Check x-fastmcp-wrap-result before unwrapping ToolResult
github-actions[bot] d79ca68
fix: use isinstance instead of hasattr, direct indexing for wrap-result
jlowin 053ff49
Merge branch 'main' into claude/issue-3021-20260203-0115
jlowin d464a2c
fix: use .get() for wrap-result unwrapping
jlowin 126e624
chore: Update SDK documentation
marvin-context-protocol[bot] facc043
fix: clean up from_callable_tool docstring
jlowin e30c8a6
chore: Update SDK documentation
marvin-context-protocol[bot] 0af2024
Merge branch 'main' into claude/issue-3021-20260203-0115
strawgate 0ab64e1
Add SamplingTool conversion helpers to v3-features rc1 section
github-actions[bot] 7460c7a
Merge remote-tracking branch 'origin/main' into claude/issue-3021-202…
github-actions[bot] 3b8a821
Use tool.run() for FunctionTool to respect output_schema
github-actions[bot] 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
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 |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| """Tests for prepare_tools helper function.""" | ||
|
|
||
| import pytest | ||
|
|
||
| from fastmcp.server.sampling.run import prepare_tools | ||
| from fastmcp.server.sampling.sampling_tool import SamplingTool | ||
| from fastmcp.tools.function_tool import FunctionTool | ||
| from fastmcp.tools.tool_transform import ArgTransform, TransformedTool | ||
|
|
||
|
|
||
| class TestPrepareTools: | ||
| """Tests for prepare_tools().""" | ||
|
|
||
| def test_prepare_tools_with_none(self): | ||
| """Test that None returns None.""" | ||
| result = prepare_tools(None) | ||
| assert result is None | ||
|
|
||
| def test_prepare_tools_with_sampling_tool(self): | ||
| """Test that SamplingTool instances pass through.""" | ||
|
|
||
| def search(query: str) -> str: | ||
| return f"Results: {query}" | ||
|
|
||
| sampling_tool = SamplingTool.from_function(search) | ||
| result = prepare_tools([sampling_tool]) | ||
|
|
||
| assert result is not None | ||
| assert len(result) == 1 | ||
| assert result[0] is sampling_tool | ||
|
|
||
| def test_prepare_tools_with_function(self): | ||
| """Test that plain functions are converted.""" | ||
|
|
||
| def search(query: str) -> str: | ||
| """Search function.""" | ||
| return f"Results: {query}" | ||
|
|
||
| result = prepare_tools([search]) | ||
|
|
||
| assert result is not None | ||
| assert len(result) == 1 | ||
| assert isinstance(result[0], SamplingTool) | ||
| assert result[0].name == "search" | ||
|
|
||
| def test_prepare_tools_with_function_tool(self): | ||
| """Test that FunctionTool instances are converted.""" | ||
|
|
||
| def search(query: str) -> str: | ||
| """Search the web.""" | ||
| return f"Results: {query}" | ||
|
|
||
| function_tool = FunctionTool.from_function(search) | ||
| result = prepare_tools([function_tool]) | ||
|
|
||
| assert result is not None | ||
| assert len(result) == 1 | ||
| assert isinstance(result[0], SamplingTool) | ||
| assert result[0].name == "search" | ||
| assert result[0].description == "Search the web." | ||
|
|
||
| def test_prepare_tools_with_transformed_tool(self): | ||
| """Test that TransformedTool instances are converted.""" | ||
|
|
||
| def original(query: str) -> str: | ||
| """Original tool.""" | ||
| return f"Results: {query}" | ||
|
|
||
| function_tool = FunctionTool.from_function(original) | ||
| transformed_tool = TransformedTool.from_tool( | ||
| function_tool, | ||
| name="search_v2", | ||
| transform_args={"query": ArgTransform(name="q")}, | ||
| ) | ||
|
|
||
| result = prepare_tools([transformed_tool]) | ||
|
|
||
| assert result is not None | ||
| assert len(result) == 1 | ||
| assert isinstance(result[0], SamplingTool) | ||
| assert result[0].name == "search_v2" | ||
| assert "q" in result[0].parameters.get("properties", {}) | ||
|
|
||
| def test_prepare_tools_with_mixed_types(self): | ||
| """Test that mixed tool types are all converted.""" | ||
|
|
||
| def plain_fn(x: int) -> int: | ||
| return x * 2 | ||
|
|
||
| def fn_for_tool(y: int) -> int: | ||
| return y * 3 | ||
|
|
||
| function_tool = FunctionTool.from_function(fn_for_tool) | ||
| sampling_tool = SamplingTool.from_function(lambda z: z * 4, name="lambda_tool") | ||
|
|
||
| result = prepare_tools([plain_fn, function_tool, sampling_tool]) | ||
|
|
||
| assert result is not None | ||
| assert len(result) == 3 | ||
| assert all(isinstance(t, SamplingTool) for t in result) | ||
|
|
||
| def test_prepare_tools_with_invalid_type(self): | ||
| """Test that invalid types raise TypeError.""" | ||
|
|
||
| with pytest.raises(TypeError, match="Expected SamplingTool, FunctionTool"): | ||
| prepare_tools(["not a tool"]) | ||
|
|
||
| def test_prepare_tools_empty_list(self): | ||
| """Test that empty list returns None.""" | ||
| result = prepare_tools([]) | ||
| assert result is None |
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.
The new TransformedTool wrapper treats any
structured_contentdict containing a"result"key as a wrapped payload and returns only that value. This loses data for legitimate schemas that include aresultfield alongside other properties (e.g.,{result: ..., source: ...}), so sampling will drop fields and stringify only the inner value. This only occurs for TransformedTool outputs with structured content that happen to include aresultkey; consider checking the tool’s output schema (e.g.,x-fastmcp-wrap-result) before unwrapping, otherwise return the dict unchanged.Useful? React with 👍 / 👎.