feat(agents): add validation for unique sub-agent names (#3557) #3576

sarojrout · 2025-11-17T05:52:42Z

Please ensure you have read the contribution guide before creating a pull request.

Link to Issue or Description of Change

1. Link to an existing issue (if applicable):

Closes: Add validation to BaseAgent to verify that all sub_agents have unique names #3557
Related: #issue_number

2. Or, if no issue exists, describe the change:

If applicable, please follow the issue templates to provide as much detail as
possible.

Problem:
When creating a BaseAgent with multiple sub-agents, there was no validation to ensure that all sub-agents have unique names. This could lead to confusion when trying to find or reference specific sub-agents by name, as duplicate names would make it ambiguous which agent is being referenced.
Solution:
Added a @field_validator for the sub_agents field in BaseAgent that validates all sub-agents have unique names. The validator:
Checks for duplicate names in the sub-agents list
Raises a ValueError with a clear error message listing all duplicate names found
Returns the validated list if all names are unique
Handles edge cases like empty lists gracefully

Testing Plan

Please describe the tests that you ran to verify your changes. This is required
for all PRs that are not small documentation or typo fixes.

Unit Tests:

I have added or updated unit tests for my change.
All unit tests pass locally.

Please include a summary of passed pytest results.
Added 4 new test cases in tests/unittests/agents/test_base_agent.py:
test_validate_sub_agents_unique_names_single_duplicate: Verifies that a single duplicate name raises ValueError
test_validate_sub_agents_unique_names_multiple_duplicates: Verifies that multiple duplicate names are all reported in the error message
test_validate_sub_agents_unique_names_no_duplicates: Verifies that unique names pass validation successfully
test_validate_sub_agents_unique_names_empty_list: Verifies that empty sub-agents list passes validation
All tests pass locally. You can run with:
pytest tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_single_duplicate tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_multiple_duplicates tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_no_duplicates tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_empty_list -v
Manual End-to-End (E2E) Tests:

Please provide instructions on how to manually test your changes, including any
necessary setup or configuration. Please provide logs or screenshots to help
reviewers better understand the fix.

Test Case 1: Duplicate names should raise error
from google.adk.agents import Agent

agent1 = Agent(name="sub_agent", model="gemini-2.5-flash")
agent2 = Agent(name="sub_agent", model="gemini-2.5-flash") # Same name

This should raise ValueError

try:
parent = Agent(
name="parent",
model="gemini-2.5-flash",
sub_agents=[agent1, agent2]
)
except ValueError as e:
print(f"Expected error: {e}")
# Output: Found duplicate sub-agent names: sub_agent. All sub-agents must have unique names.

Test Case 2: Unique names should work
from google.adk.agents import Agent

agent1 = Agent(name="agent1", model="gemini-2.5-flash")
agent2 = Agent(name="agent2", model="gemini-2.5-flash")

This should work without error

parent = Agent(
name="parent",
model="gemini-2.5-flash",
sub_agents=[agent1, agent2]
)
print("Success: Unique names validated correctly")

Checklist

I have read the CONTRIBUTING.md document.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have added tests that prove my fix is effective or that my feature works.
New and existing unit tests pass locally with my changes.
I have manually tested my changes end-to-end.
Any dependent changes have been merged and published in downstream modules.

Additional context

This change adds validation at the BaseAgent level, so it automatically applies to all agent types that inherit from BaseAgent (e.g., LlmAgent, LoopAgent, etc.). The validation uses Pydantic's field validator system, which runs during object initialization, ensuring the constraint is enforced early and consistently.
The error message clearly identifies which names are duplicated, making it easy for developers to fix the issue:

gemini-code-assist · 2025-11-17T05:52:59Z

Summary of Changes

Hello @sarojrout, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a potential ambiguity issue where BaseAgent instances could be initialized with sub-agents having non-unique names. By integrating a Pydantic field validator, the system now enforces uniqueness among sub-agent names during object creation. This enhancement improves data integrity, prevents confusion when referencing sub-agents, and provides immediate feedback to developers through descriptive error messages, ensuring a more robust and predictable agent hierarchy.

Highlights

Sub-Agent Name Uniqueness: Introduced a Pydantic field validator to ensure all sub-agents within a BaseAgent have unique names, preventing ambiguity and potential issues.
Robust Error Handling: Implemented robust error handling that raises a ValueError with a clear, descriptive message listing all detected duplicate names, aiding developers in quick resolution.
Comprehensive Unit Testing: Added comprehensive unit tests covering various scenarios, including single duplicates, multiple duplicates, unique names, and empty sub-agent lists, to ensure the validation works as expected.
Automatic Inheritance: Ensured the new validation automatically applies to all agent types that inherit from BaseAgent (e.g., LlmAgent, LoopAgent), providing consistent behavior across the agent hierarchy.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a valuable validation check to ensure that sub-agents within a BaseAgent have unique names. The implementation is sound and the inclusion of unit tests is great. I've provided a couple of suggestions. One is to refine the error message to avoid redundancy when a name is duplicated multiple times. The other is to strengthen the unit tests to be more specific in their assertions, which will make them more robust against future changes. Overall, this is a solid contribution that improves the reliability of agent creation.

src/google/adk/agents/base_agent.py

tests/unittests/agents/test_base_agent.py

…oogle#3557)

src/google/adk/agents/base_agent.py

Change duplicates from list to set for better efficiency and cleaner code. Remove unnecessary set() conversion when sorting duplicates.

ryanaiagent · 2025-11-20T23:18:07Z

Hi @sarojrout , can you fix the lint errors.

sarojrout · 2025-11-21T00:10:15Z

Hi @sarojrout , can you fix the lint errors.

done. can you pls verify? thanks!

ryanaiagent · 2025-11-21T00:39:22Z

Hi @slilichenko, can you please review this now.

slilichenko · 2025-11-21T00:55:51Z

@ryanaiagent LGTM, but I am not an official reviewer/committer on this project.

ryanaiagent · 2025-11-21T01:03:51Z

Hi @DeanChensj , can you please review this.

Merge #3576 **Please ensure you have read the [contribution guide](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) before creating a pull request.** ### Link to Issue or Description of Change **1. Link to an existing issue (if applicable):** - Closes: #3557 - Related: #_issue_number_ **2. Or, if no issue exists, describe the change:** _If applicable, please follow the issue templates to provide as much detail as possible._ **Problem:** When creating a BaseAgent with multiple sub-agents, there was no validation to ensure that all sub-agents have unique names. This could lead to confusion when trying to find or reference specific sub-agents by name, as duplicate names would make it ambiguous which agent is being referenced. **Solution:** Added a @field_validator for the sub_agents field in BaseAgent that validates all sub-agents have unique names. The validator: Checks for duplicate names in the sub-agents list Raises a ValueError with a clear error message listing all duplicate names found Returns the validated list if all names are unique Handles edge cases like empty lists gracefully ### Testing Plan _Please describe the tests that you ran to verify your changes. This is required for all PRs that are not small documentation or typo fixes._ **Unit Tests:** - [x] I have added or updated unit tests for my change. - [x] All unit tests pass locally. _Please include a summary of passed `pytest` results._ Added 4 new test cases in tests/unittests/agents/test_base_agent.py: test_validate_sub_agents_unique_names_single_duplicate: Verifies that a single duplicate name raises ValueError test_validate_sub_agents_unique_names_multiple_duplicates: Verifies that multiple duplicate names are all reported in the error message test_validate_sub_agents_unique_names_no_duplicates: Verifies that unique names pass validation successfully test_validate_sub_agents_unique_names_empty_list: Verifies that empty sub-agents list passes validation All tests pass locally. You can run with: pytest tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_single_duplicate tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_multiple_duplicates tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_no_duplicates tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_empty_list -v **Manual End-to-End (E2E) Tests:** _Please provide instructions on how to manually test your changes, including any necessary setup or configuration. Please provide logs or screenshots to help reviewers better understand the fix._ Test Case 1: Duplicate names should raise error from google.adk.agents import Agent agent1 = Agent(name="sub_agent", model="gemini-2.5-flash") agent2 = Agent(name="sub_agent", model="gemini-2.5-flash") # Same name # This should raise ValueError try: parent = Agent( name="parent", model="gemini-2.5-flash", sub_agents=[agent1, agent2] ) except ValueError as e: print(f"Expected error: {e}") # Output: Found duplicate sub-agent names: `sub_agent`. All sub-agents must have unique names. Test Case 2: Unique names should work from google.adk.agents import Agent agent1 = Agent(name="agent1", model="gemini-2.5-flash") agent2 = Agent(name="agent2", model="gemini-2.5-flash") # This should work without error parent = Agent( name="parent", model="gemini-2.5-flash", sub_agents=[agent1, agent2] ) print("Success: Unique names validated correctly") ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have added tests that prove my fix is effective or that my feature works. - [x] New and existing unit tests pass locally with my changes. - [x] I have manually tested my changes end-to-end. - [x] Any dependent changes have been merged and published in downstream modules. ### Additional context This change adds validation at the BaseAgent level, so it automatically applies to all agent types that inherit from BaseAgent (e.g., LlmAgent, LoopAgent, etc.). The validation uses Pydantic's field validator system, which runs during object initialization, ensuring the constraint is enforced early and consistently. The error message clearly identifies which names are duplicated, making it easy for developers to fix the issue: COPYBARA_INTEGRATE_REVIEW=#3576 from sarojrout:feat/validate-unique-sub-agent-names 07adf1f PiperOrigin-RevId: 835358118

adk-bot · 2025-11-21T22:24:18Z

Thank you @sarojrout for your contribution! 🎉

Your changes have been successfully imported and merged via Copybara in commit 2247a45.

Closing this PR as the changes are now in the main branch.

Merge google#3576 **Please ensure you have read the [contribution guide](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) before creating a pull request.** ### Link to Issue or Description of Change **1. Link to an existing issue (if applicable):** - Closes: google#3557 - Related: #_issue_number_ **2. Or, if no issue exists, describe the change:** _If applicable, please follow the issue templates to provide as much detail as possible._ **Problem:** When creating a BaseAgent with multiple sub-agents, there was no validation to ensure that all sub-agents have unique names. This could lead to confusion when trying to find or reference specific sub-agents by name, as duplicate names would make it ambiguous which agent is being referenced. **Solution:** Added a @field_validator for the sub_agents field in BaseAgent that validates all sub-agents have unique names. The validator: Checks for duplicate names in the sub-agents list Raises a ValueError with a clear error message listing all duplicate names found Returns the validated list if all names are unique Handles edge cases like empty lists gracefully ### Testing Plan _Please describe the tests that you ran to verify your changes. This is required for all PRs that are not small documentation or typo fixes._ **Unit Tests:** - [x] I have added or updated unit tests for my change. - [x] All unit tests pass locally. _Please include a summary of passed `pytest` results._ Added 4 new test cases in tests/unittests/agents/test_base_agent.py: test_validate_sub_agents_unique_names_single_duplicate: Verifies that a single duplicate name raises ValueError test_validate_sub_agents_unique_names_multiple_duplicates: Verifies that multiple duplicate names are all reported in the error message test_validate_sub_agents_unique_names_no_duplicates: Verifies that unique names pass validation successfully test_validate_sub_agents_unique_names_empty_list: Verifies that empty sub-agents list passes validation All tests pass locally. You can run with: pytest tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_single_duplicate tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_multiple_duplicates tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_no_duplicates tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_empty_list -v **Manual End-to-End (E2E) Tests:** _Please provide instructions on how to manually test your changes, including any necessary setup or configuration. Please provide logs or screenshots to help reviewers better understand the fix._ Test Case 1: Duplicate names should raise error from google.adk.agents import Agent agent1 = Agent(name="sub_agent", model="gemini-2.5-flash") agent2 = Agent(name="sub_agent", model="gemini-2.5-flash") # Same name # This should raise ValueError try: parent = Agent( name="parent", model="gemini-2.5-flash", sub_agents=[agent1, agent2] ) except ValueError as e: print(f"Expected error: {e}") # Output: Found duplicate sub-agent names: `sub_agent`. All sub-agents must have unique names. Test Case 2: Unique names should work from google.adk.agents import Agent agent1 = Agent(name="agent1", model="gemini-2.5-flash") agent2 = Agent(name="agent2", model="gemini-2.5-flash") # This should work without error parent = Agent( name="parent", model="gemini-2.5-flash", sub_agents=[agent1, agent2] ) print("Success: Unique names validated correctly") ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have added tests that prove my fix is effective or that my feature works. - [x] New and existing unit tests pass locally with my changes. - [x] I have manually tested my changes end-to-end. - [x] Any dependent changes have been merged and published in downstream modules. ### Additional context This change adds validation at the BaseAgent level, so it automatically applies to all agent types that inherit from BaseAgent (e.g., LlmAgent, LoopAgent, etc.). The validation uses Pydantic's field validator system, which runs during object initialization, ensuring the constraint is enforced early and consistently. The error message clearly identifies which names are duplicated, making it easy for developers to fix the issue: COPYBARA_INTEGRATE_REVIEW=google#3576 from sarojrout:feat/validate-unique-sub-agent-names 07adf1f PiperOrigin-RevId: 835358118

feat(agents): add validation for unique sub-agent names (google#3557)

4028ecf

adk-bot added the core [Component] This issue is related to the core interface and implementation label Nov 17, 2025

gemini-code-assist bot reviewed Nov 17, 2025

View reviewed changes

src/google/adk/agents/base_agent.py Outdated Show resolved Hide resolved

tests/unittests/agents/test_base_agent.py Show resolved Hide resolved

sarojrout added 2 commits November 16, 2025 21:57

fix(agents): deduplicate and sort duplicate names in error message (g…

e8dbafe

…oogle#3557)

Merge branch 'main' into feat/validate-unique-sub-agent-names

f7c9c9c

ryanaiagent self-assigned this Nov 18, 2025

Merge branch 'main' into feat/validate-unique-sub-agent-names

f4a0c4a

slilichenko reviewed Nov 19, 2025

View reviewed changes

src/google/adk/agents/base_agent.py Outdated Show resolved Hide resolved

slilichenko reviewed Nov 19, 2025

View reviewed changes

src/google/adk/agents/base_agent.py Outdated Show resolved Hide resolved

sarojrout added 3 commits November 19, 2025 16:15

refactor(agents): use set for duplicates in validator

ad54196

Change duplicates from list to set for better efficiency and cleaner code. Remove unnecessary set() conversion when sorting duplicates.

Merge branch 'main' into feat/validate-unique-sub-agent-names

e071bf6

Merge branch 'main' into feat/validate-unique-sub-agent-names

6db17c4

ryanaiagent added the request clarification [Status] The maintainer need clarification or more information from the author label Nov 20, 2025

fixed the linting error

966aaf0

ryanaiagent added needs-review [Status] The PR is awaiting review from the maintainer and removed request clarification [Status] The maintainer need clarification or more information from the author labels Nov 21, 2025

Merge branch 'main' into feat/validate-unique-sub-agent-names

07adf1f

DeanChensj approved these changes Nov 21, 2025

View reviewed changes

DeanChensj added ready to pull [Status] This PR is ready to be importing back to Google and removed needs-review [Status] The PR is awaiting review from the maintainer labels Nov 21, 2025

adk-bot closed this Nov 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(agents): add validation for unique sub-agent names (#3557) #3576

feat(agents): add validation for unique sub-agent names (#3557) #3576

Uh oh!

sarojrout commented Nov 17, 2025

Uh oh!

gemini-code-assist bot commented Nov 17, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanaiagent commented Nov 20, 2025

Uh oh!

sarojrout commented Nov 21, 2025

Uh oh!

ryanaiagent commented Nov 21, 2025 •

edited

Loading

Uh oh!

slilichenko commented Nov 21, 2025

Uh oh!

ryanaiagent commented Nov 21, 2025

Uh oh!

adk-bot commented Nov 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

feat(agents): add validation for unique sub-agent names (#3557) #3576

feat(agents): add validation for unique sub-agent names (#3557) #3576

Uh oh!

Conversation

sarojrout commented Nov 17, 2025

Link to Issue or Description of Change

Testing Plan

This should raise ValueError

This should work without error

Checklist

Additional context

Uh oh!

gemini-code-assist bot commented Nov 17, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanaiagent commented Nov 20, 2025

Uh oh!

sarojrout commented Nov 21, 2025

Uh oh!

ryanaiagent commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slilichenko commented Nov 21, 2025

Uh oh!

ryanaiagent commented Nov 21, 2025

Uh oh!

adk-bot commented Nov 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ryanaiagent commented Nov 21, 2025 •

edited

Loading