Add examples field to ToolDefinition and send it to Anthropic
#3619
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
This adds support for providing example inputs to help the model understand correct tool usage patterns. - Add `input_examples` field to `ToolDefinition` dataclass - Add `input_examples` parameter to `Tool` class - Update `FunctionToolset.tool`, `add_function` decorators - Update `Agent.tool_plain` decorator - Update Anthropic model to pass `input_examples` to API - Automatically enable `advanced-tool-use-2025-11-20` beta when used - Add tests in `tests/models/anthropic/test_input_examples.py` Supported by Anthropic models. See https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/tool-use-examples 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
DouweM
requested changes
Dec 2, 2025
| For MCP tools, this contains the `meta`, `annotations`, and `output_schema` fields from the tool definition. | ||
| """ | ||
|
|
||
| input_examples: list[dict[str, Any]] | None = None |
Collaborator
There was a problem hiding this comment.
Anthropic calls them input_examples because they have input_schema, but we have parameters_json_schema, so let's call it either parameters_examples or, better, just examples.
| sequential: bool | ||
| requires_approval: bool | ||
| metadata: dict[str, Any] | None | ||
| input_examples: list[dict[str, Any]] | None |
Collaborator
There was a problem hiding this comment.
We should also add this to OutputTool!
| # Check if any tools use input_examples (advanced tool use feature) | ||
| has_input_examples = any(tool.get('input_examples') for tool in tools) | ||
| if has_input_examples: | ||
| betas.add('advanced-tool-use-2025-11-20') |
Collaborator
There was a problem hiding this comment.
There's a different beta header for Vertex and Bedrock: https://platform.claude.com/docs/en/agents-and-tools/tool-use/implement-tool-use#providing-tool-use-examples
That's relevant when using AnthropicModel with AnthropicProvider and a custom anthropic_client like AsyncAnthropicVertex. So we should check the type of self._client to send the right header.
DouweM
changed the title
examples field to ToolDefinition and send it to Anthropic
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Adds support for providing example inputs to help the model understand correct tool usage patterns.
input_examplesfield toToolDefinitiondataclassinput_examplesparameter toToolclassFunctionToolset.tool,add_functiondecoratorsAgent.tool_plaindecoratorinput_examplesto APIadvanced-tool-use-2025-11-20beta header wheninput_examplesis usedSupported by Anthropic models.
See https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/tool-use-examples
Test plan
tests/models/anthropic/test_input_examples.pyRelated
Split from #3550 per @DouweM's recommendation to separate the features into individual PRs.
🤖 Generated with Claude Code