Python: [BREAKING] Renamed AgentProtocol to SupportsAgentRun (#3717)

* Renamed AgentProtocol to AgentLike

* Resolved comments

* Renamed AgentLike to SupportsAgentRun

* Resolved comments

python/samples/concepts/tools/README.md

@@ -131,7 +131,7 @@ sequenceDiagram
 
 | Field | Type | Description |
 |-------|------|-------------|
-| `agent` | `AgentProtocol` | The agent being invoked |
+| `agent` | `SupportsAgentRun` | The agent being invoked |
 | `messages` | `list[ChatMessage]` | Input messages (mutable) |
 | `thread` | `AgentThread \| None` | Conversation thread |
 | `options` | `Mapping[str, Any]` | Chat options dict |

python/samples/getting_started/agents/azure_ai/azure_ai_with_hosted_mcp.py

@@ -3,7 +3,7 @@
 import asyncio
 from typing import Any
 
-from agent_framework import AgentProtocol, AgentResponse, AgentThread, ChatMessage, HostedMCPTool
+from agent_framework import SupportsAgentRun, AgentResponse, AgentThread, ChatMessage, HostedMCPTool
 from agent_framework.azure import AzureAIProjectAgentProvider
 from azure.identity.aio import AzureCliCredential
 
@@ -14,7 +14,7 @@ This sample demonstrates integrating hosted Model Context Protocol (MCP) tools w
 """
 
 
-async def handle_approvals_without_thread(query: str, agent: "AgentProtocol") -> AgentResponse:
+async def handle_approvals_without_thread(query: str, agent: "SupportsAgentRun") -> AgentResponse:
     """When we don't have a thread, we need to ensure we return with the input, approval request and approval."""
 
     result = await agent.run(query, store=False)
@@ -35,7 +35,7 @@ async def handle_approvals_without_thread(query: str, agent: "AgentProtocol") ->
     return result
 
 
-async def handle_approvals_with_thread(query: str, agent: "AgentProtocol", thread: "AgentThread") -> AgentResponse:
+async def handle_approvals_with_thread(query: str, agent: "SupportsAgentRun", thread: "AgentThread") -> AgentResponse:
     """Here we let the thread deal with the previous responses, and we just rerun with the approval."""
 
     result = await agent.run(query, thread=thread)

python/samples/getting_started/agents/azure_ai_agent/azure_ai_with_hosted_mcp.py

@@ -3,7 +3,7 @@
 import asyncio
 from typing import Any
 
-from agent_framework import AgentProtocol, AgentResponse, AgentThread, HostedMCPTool
+from agent_framework import SupportsAgentRun, AgentResponse, AgentThread, HostedMCPTool
 from agent_framework.azure import AzureAIAgentsProvider
 from azure.identity.aio import AzureCliCredential
 
@@ -15,7 +15,7 @@ servers, including user approval workflows for function call security.
 """
 
 
-async def handle_approvals_with_thread(query: str, agent: "AgentProtocol", thread: "AgentThread") -> AgentResponse:
+async def handle_approvals_with_thread(query: str, agent: "SupportsAgentRun", thread: "AgentThread") -> AgentResponse:
     """Here we let the thread deal with the previous responses, and we just rerun with the approval."""
     from agent_framework import ChatMessage
 

python/samples/getting_started/agents/azure_ai_agent/azure_ai_with_multiple_tools.py

@@ -5,7 +5,7 @@ from datetime import datetime, timezone
 from typing import Any
 
 from agent_framework import (
-    AgentProtocol,
+    SupportsAgentRun,
     AgentThread,
     HostedMCPTool,
     HostedWebSearchTool,
@@ -43,7 +43,7 @@ def get_time() -> str:
     return f"The current UTC time is {current_time.strftime('%Y-%m-%d %H:%M:%S')}."
 
 
-async def handle_approvals_with_thread(query: str, agent: "AgentProtocol", thread: "AgentThread"):
+async def handle_approvals_with_thread(query: str, agent: "SupportsAgentRun", thread: "AgentThread"):
     """Here we let the thread deal with the previous responses, and we just rerun with the approval."""
     from agent_framework import ChatMessage
 

python/samples/getting_started/agents/azure_openai/azure_responses_client_with_hosted_mcp.py

@@ -15,10 +15,10 @@ Azure OpenAI Responses Client, including user approval workflows for function ca
 """
 
 if TYPE_CHECKING:
-    from agent_framework import AgentProtocol, AgentThread
+    from agent_framework import SupportsAgentRun, AgentThread
 
 
-async def handle_approvals_without_thread(query: str, agent: "AgentProtocol"):
+async def handle_approvals_without_thread(query: str, agent: "SupportsAgentRun"):
     """When we don't have a thread, we need to ensure we return with the input, approval request and approval."""
     from agent_framework import ChatMessage
 
@@ -40,7 +40,7 @@ async def handle_approvals_without_thread(query: str, agent: "AgentProtocol"):
     return result
 
 
-async def handle_approvals_with_thread(query: str, agent: "AgentProtocol", thread: "AgentThread"):
+async def handle_approvals_with_thread(query: str, agent: "SupportsAgentRun", thread: "AgentThread"):
     """Here we let the thread deal with the previous responses, and we just rerun with the approval."""
     from agent_framework import ChatMessage
 
@@ -63,7 +63,7 @@ async def handle_approvals_with_thread(query: str, agent: "AgentProtocol", threa
     return result
 
 
-async def handle_approvals_with_thread_streaming(query: str, agent: "AgentProtocol", thread: "AgentThread"):
+async def handle_approvals_with_thread_streaming(query: str, agent: "SupportsAgentRun", thread: "AgentThread"):
     """Here we let the thread deal with the previous responses, and we just rerun with the approval."""
     from agent_framework import ChatMessage
 

python/samples/getting_started/agents/openai/openai_responses_client_with_hosted_mcp.py

@@ -14,10 +14,10 @@ OpenAI Responses Client, including user approval workflows for function call sec
 """
 
 if TYPE_CHECKING:
-    from agent_framework import AgentProtocol, AgentThread
+    from agent_framework import SupportsAgentRun, AgentThread
 
 
-async def handle_approvals_without_thread(query: str, agent: "AgentProtocol"):
+async def handle_approvals_without_thread(query: str, agent: "SupportsAgentRun"):
     """When we don't have a thread, we need to ensure we return with the input, approval request and approval."""
     from agent_framework import ChatMessage
 
@@ -39,7 +39,7 @@ async def handle_approvals_without_thread(query: str, agent: "AgentProtocol"):
     return result
 
 
-async def handle_approvals_with_thread(query: str, agent: "AgentProtocol", thread: "AgentThread"):
+async def handle_approvals_with_thread(query: str, agent: "SupportsAgentRun", thread: "AgentThread"):
     """Here we let the thread deal with the previous responses, and we just rerun with the approval."""
     from agent_framework import ChatMessage
 
@@ -62,7 +62,7 @@ async def handle_approvals_with_thread(query: str, agent: "AgentProtocol", threa
     return result
 
 
-async def handle_approvals_with_thread_streaming(query: str, agent: "AgentProtocol", thread: "AgentThread"):
+async def handle_approvals_with_thread_streaming(query: str, agent: "SupportsAgentRun", thread: "AgentThread"):
     """Here we let the thread deal with the previous responses, and we just rerun with the approval."""
     from agent_framework import ChatMessage
 

python/samples/getting_started/orchestrations/concurrent_agents.py

@@ -56,7 +56,7 @@ async def main() -> None:
     )
 
     # 2) Build a concurrent workflow
-    # Participants are either Agents (type of AgentProtocol) or Executors
+    # Participants are either Agents (type of SupportsAgentRun) or Executors
     workflow = ConcurrentBuilder().participants([researcher, marketer, legal]).build()
 
     # 3) Run with a single prompt and pretty-print the final combined messages

python/samples/getting_started/orchestrations/concurrent_custom_aggregator.py

@@ -80,7 +80,7 @@ async def main() -> None:
         return response.messages[-1].text if response.messages else ""
 
     # Build with a custom aggregator callback function
-    # - participants([...]) accepts AgentProtocol (agents) or Executor instances.
+    # - participants([...]) accepts SupportsAgentRun (agents) or Executor instances.
     #   Each participant becomes a parallel branch (fan-out) from an internal dispatcher.
     # - with_aggregator(...) overrides the default aggregator:
     #   • Default aggregator -> returns list[ChatMessage] (one user + one assistant per agent)

python/samples/getting_started/orchestrations/concurrent_participant_factory.py

@@ -122,7 +122,7 @@ async def run_workflow(workflow: Workflow, query: str) -> None:
 async def main() -> None:
     # Create a concurrent builder with participant factories and a custom aggregator
     # - register_participants([...]) accepts factory functions that return
-    #   AgentProtocol (agents) or Executor instances.
+    #   SupportsAgentRun (agents) or Executor instances.
     # - register_aggregator(...) takes a factory function that returns an Executor instance.
     concurrent_builder = (
         ConcurrentBuilder()

python/samples/getting_started/orchestrations/magentic.py

@@ -51,8 +51,6 @@ async def main() -> None:
             "You are a Researcher. You find information without additional computation or quantitative analysis."
         ),
         # This agent requires the gpt-4o-search-preview model to perform web searches.
-        # Feel free to explore with other agents that support web search, for example,
-        # the `OpenAIResponseAgent` or `AzureAgentProtocol` with bing grounding.
         chat_client=OpenAIChatClient(model_id="gpt-4o-search-preview"),
     )
 

python/samples/getting_started/tools/function_tool_with_approval.py

@@ -8,7 +8,7 @@ from agent_framework import AgentResponse, ChatAgent, ChatMessage, tool
 from agent_framework.openai import OpenAIResponsesClient
 
 if TYPE_CHECKING:
-    from agent_framework import AgentProtocol
+    from agent_framework import SupportsAgentRun
 
 """
 Demonstration of a tool with approvals.
@@ -40,7 +40,7 @@ def get_weather_detail(location: Annotated[str, "The city and state, e.g. San Fr
     )
 
 
-async def handle_approvals(query: str, agent: "AgentProtocol") -> AgentResponse:
+async def handle_approvals(query: str, agent: "SupportsAgentRun") -> AgentResponse:
     """Handle function call approvals.
 
     When we don't have a thread, we need to ensure we include the original query,
@@ -75,7 +75,7 @@ async def handle_approvals(query: str, agent: "AgentProtocol") -> AgentResponse:
     return result
 
 
-async def handle_approvals_streaming(query: str, agent: "AgentProtocol") -> None:
+async def handle_approvals_streaming(query: str, agent: "SupportsAgentRun") -> None:
     """Handle function call approvals with streaming responses.
 
     When we don't have a thread, we need to ensure we include the original query,

python/samples/getting_started/workflows/agents/magentic_workflow_as_agent.py

@@ -29,8 +29,6 @@ async def main() -> None:
             "You are a Researcher. You find information without additional computation or quantitative analysis."
         ),
         # This agent requires the gpt-4o-search-preview model to perform web searches.
-        # Feel free to explore with other agents that support web search, for example,
-        # the `OpenAIResponseAgent` or `AzureAgentProtocol` with bing grounding.
         chat_client=OpenAIChatClient(model_id="gpt-4o-search-preview"),
     )