-
Notifications
You must be signed in to change notification settings - Fork 2.9k
fix: validate tool types in Agent.tools list to prevent runtime AttributeError (fixes #1443) #1974
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
Closed
Closed
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,7 @@ | |
| from typing_extensions import NotRequired, TypeAlias, TypedDict | ||
|
|
||
| from .agent_output import AgentOutputSchemaBase | ||
| from .exceptions import UserError | ||
| from .guardrail import InputGuardrail, OutputGuardrail | ||
| from .handoffs import Handoff | ||
| from .items import ItemHelpers | ||
|
|
@@ -246,6 +247,23 @@ def __post_init__(self): | |
| if not isinstance(self.tools, list): | ||
| raise TypeError(f"Agent tools must be a list, got {type(self.tools).__name__}") | ||
|
|
||
| # Validate each tool is a valid Tool type | ||
| # Tool is a Union type, so we need to get the valid types from it | ||
| from typing import get_args | ||
|
|
||
| valid_tool_types = get_args(Tool) + (Handoff,) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe Handoff should not be included in valid_tool_types. See the related discussion here: |
||
|
|
||
| for i, tool in enumerate(self.tools): | ||
| if not isinstance(tool, valid_tool_types): | ||
| # Generate a friendly list of valid types for the error message | ||
| type_names = ", ".join(t.__name__ for t in valid_tool_types) | ||
| raise UserError( | ||
| f"tools[{i}] must be a valid Tool object ({type_names}), " | ||
| f"got {type(tool).__name__}. " | ||
| f"Did you forget to use @function_tool decorator or pass the function itself " | ||
| f"instead of a tool?" | ||
| ) | ||
|
|
||
| if not isinstance(self.mcp_servers, list): | ||
| raise TypeError( | ||
| f"Agent mcp_servers must be a list, got {type(self.mcp_servers).__name__}" | ||
|
|
||
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
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.
I think this import should be placed at the top of the file with the other imports.