yujunjun/autogen
1
0
Fork 0
mirror of https://github.com/microsoft/autogen.git synced 2025-12-05 03:18:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation warnings for AgentTool/TeamTool parallel tool calls limitation (#6883)

Browse Source 
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ekzhu <320302+ekzhu@users.noreply.github.com>
Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
This commit is contained in:
Copilot 2025-08-01 19:19:32 -05:00 committed by GitHub
parent c1e4ae6819
commit 3e30f9e05d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 33 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
python/docs/src/user-guide/agentchat-user-guide/tutorial/agents.ipynb
View File

@ -433,6 +433,13 @@
"when agent behavior needs to be consistent across different models.\n",
"This should be done at the model client level.\n",
"\n",
"```{important}\n",
"When using {py:class}`~autogen_agentchat.tools.AgentTool` or {py:class}`~autogen_agentchat.tools.TeamTool`,\n",
"you **must** disable parallel tool calls to avoid concurrency issues.\n",
"These tools cannot run concurrently as agents and teams maintain internal state\n",
"that would conflict with parallel execution.\n",
"```\n",
"\n",
"For {py:class}`~autogen_ext.models.openai.OpenAIChatCompletionClient` and {py:class}`~autogen_ext.models.openai.AzureOpenAIChatCompletionClient`,\n",
"set `parallel_tool_calls=False` to disable parallel tool calls."
]

12
python/packages/autogen-agentchat/src/autogen_agentchat/tools/_agent.py
View File

@ -22,6 +22,13 @@ class AgentTool(TaskRunnerTool, Component[AgentToolConfig]):
The tool returns the result of the task execution as a :class:`~autogen_agentchat.base.TaskResult` object.
.. important::
When using AgentTool, you **must** disable parallel tool calls in the model client configuration
to avoid concurrency issues. Agents cannot run concurrently as they maintain internal state
that would conflict with parallel execution. For example, set ``parallel_tool_calls=False``
for :class:`~autogen_ext.models.openai.OpenAIChatCompletionClient` and
:class:`~autogen_ext.models.openai.AzureOpenAIChatCompletionClient`.
Args:
agent (BaseChatAgent): The agent to be used for running the task.
return_value_as_last_message (bool): Whether to use the last message content of the task result
@ -51,9 +58,12 @@ class AgentTool(TaskRunnerTool, Component[AgentToolConfig]):
system_message="Write well.",
)
writer_tool = AgentTool(agent=writer)
# Create model client with parallel tool calls disabled for the main agent
main_model_client = OpenAIChatCompletionClient(model="gpt-4", parallel_tool_calls=False)
assistant = AssistantAgent(
name="assistant",
model_client=model_client,
model_client=main_model_client,
tools=[writer_tool],
system_message="You are a helpful assistant.",
)

17
python/packages/autogen-agentchat/src/autogen_agentchat/tools/_team.py
View File

@ -25,6 +25,13 @@ class TeamTool(TaskRunnerTool, Component[TeamToolConfig]):
The tool returns the result of the task execution as a :class:`~autogen_agentchat.base.TaskResult` object.
.. important::
When using TeamTool, you **must** disable parallel tool calls in the model client configuration
to avoid concurrency issues. Teams cannot run concurrently as they maintain internal state
that would conflict with parallel execution. For example, set ``parallel_tool_calls=False``
for :class:`~autogen_ext.models.openai.OpenAIChatCompletionClient` and
:class:`~autogen_ext.models.openai.AzureOpenAIChatCompletionClient`.
Args:
team (BaseGroupChat): The team to be used for running the task.
name (str): The name of the tool.
@ -48,6 +55,7 @@ class TeamTool(TaskRunnerTool, Component[TeamToolConfig]):
async def main() -> None:
# Disable parallel tool calls when using TeamTool
model_client = OllamaChatCompletionClient(model="llama3.2")
writer = AssistantAgent(name="writer", model_client=model_client, system_message="You are a helpful assistant.")
@ -65,12 +73,17 @@ class TeamTool(TaskRunnerTool, Component[TeamToolConfig]):
# Create a TeamTool that uses the team to run tasks, returning the last message as the result.
tool = TeamTool(
team=team, name="writing_team", description="A tool for writing tasks.", return_value_as_last_message=True
team=team,
name="writing_team",
description="A tool for writing tasks.",
return_value_as_last_message=True,
)
# Create model client with parallel tool calls disabled for the main agent
main_model_client = OllamaChatCompletionClient(model="llama3.2", parallel_tool_calls=False)
main_agent = AssistantAgent(
name="main_agent",
model_client=model_client,
model_client=main_model_client,
system_message="You are a helpful assistant that can use the writing tool.",
tools=[tool],
)