feat: update structured_output tool name to reduce user confusion #534
+13
−9
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.
Description
Based on the uploaded file and conversation history, here's the suggested pull request description:
Problem:
Users are experiencing confusion when using structured output functionality. When using:
The tools from the main agent are incrementing normally, but the structured output functionality creates an ephemeral agent that always shows "Tool #1: {model name}" in the output. This is causing confusion since this tool is actually the structured output tool.
For example for a grocery buying agent constructed using
Solution:
This PR updates the tool naming convention by appending "OutputStructurer" to the model name (e.g., "GroceryOutputStructurer" instead of just "Grocery"). This change makes it clearer to users which tool is handling the structured output functionality and reduces confusion around tool numbering.
This should result in something slightly more obvious regarding where the tool is coming from like
Type of Change
Other (please describe): This should not be breaking as the interface has not changed but this change modifies the internal Agent's tool name
Testing
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
hatch run prepare
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.