switch function tool to always_require

Author: eavanvalkenburg

python/packages/ag-ui/agent_framework_ag_ui_examples/agents/ui_generator_agent.py

@@ -3,16 +3,19 @@
 """Example agent demonstrating Tool-based Generative UI (Feature 5)."""
 
 import sys
-from typing import Any, TypedDict
+from typing import TYPE_CHECKING, Any, TypedDict
 
-from agent_framework import ChatAgent, ChatClientProtocol, ChatOptions, FunctionTool
+from agent_framework import ChatAgent, ChatClientProtocol, FunctionTool
 from agent_framework.ag_ui import AgentFrameworkAgent
 
 if sys.version_info >= (3, 13):
     from typing import TypeVar  # type: ignore # pragma: no cover
 else:
     from typing_extensions import TypeVar  # type: ignore # pragma: no cover
 
+if TYPE_CHECKING:
+    from agent_framework import ChatOptions
+
 # Declaration-only tools (func=None) - actual rendering happens on the client side
 generate_haiku = FunctionTool[Any, str](
     name="generate_haiku",

python/packages/core/agent_framework/_tools.py

@@ -33,7 +33,7 @@
     runtime_checkable,
 )
 
-from opentelemetry.metrics import Histogram
+from opentelemetry.metrics import Histogram, NoOpHistogram
 from pydantic import AnyUrl, BaseModel, Field, ValidationError, create_model
 
 from ._logging import get_logger
@@ -68,7 +68,9 @@
 if sys.version_info >= (3, 13):
     from typing import TypeVar as TypeVarWithDefaults  # type: ignore # pragma: no cover
 else:
-    from typing_extensions import TypeVar as TypeVarWithDefaults  # type: ignore[import] # pragma: no cover
+    from typing_extensions import (
+        TypeVar as TypeVarWithDefaults,  # type: ignore[import] # pragma: no cover
+    )
 
 logger = get_logger()
 
@@ -99,14 +101,6 @@
 ReturnT = TypeVarWithDefaults("ReturnT", default=Any)
 
 
-class _NoOpHistogram:
-    def record(self, *args: Any, **kwargs: Any) -> None:  # pragma: no cover - trivial
-        return None
-
-
-_NOOP_HISTOGRAM = _NoOpHistogram()
-
-
 def _parse_inputs(
     inputs: "Content | dict[str, Any] | str | list[Content | dict[str, Any] | str] | None",
 ) -> list["Content"]:
@@ -549,7 +543,7 @@ def _default_histogram() -> Histogram:
     from .observability import OBSERVABILITY_SETTINGS  # local import to avoid circulars
 
     if not OBSERVABILITY_SETTINGS.ENABLED:  # type: ignore[name-defined]
-        return _NOOP_HISTOGRAM  # type: ignore[return-value]
+        return NoOpHistogram()  # type: ignore[return-value]
     meter = get_meter()
     try:
         return meter.create_histogram(
@@ -588,7 +582,7 @@ class FunctionTool(BaseTool, Generic[ArgsT, ReturnT]):
 
 
             # Using the decorator with string annotations
-            @tool
+            @tool(approval_mode="never_require")
             def get_weather(
                 location: Annotated[str, "The city name"],
                 unit: Annotated[str, "Temperature unit"] = "celsius",
@@ -637,7 +631,7 @@ def __init__(
             name: The name of the function.
             description: A description of the function.
             approval_mode: Whether or not approval is required to run this tool.
-                Default is that approval is not needed.
+                Default is that approval is required.
             max_invocations: The maximum number of times this function can be invoked.
                 If None, there is no limit. Should be at least 1.
             max_invocation_exceptions: The maximum number of exceptions allowed during invocations.
@@ -658,8 +652,8 @@ def __init__(
         self.func = func
         self._instance = None  # Store the instance for bound methods
         self.input_model = self._resolve_input_model(input_model)
-        self._cached_parameters: dict[str, Any] | None = None  # Cache for model_json_schema()
-        self.approval_mode = approval_mode or "never_require"
+        self._cached_parameters: dict[str, Any] | None = None
+        self.approval_mode = approval_mode or "always_require"
         if max_invocations is not None and max_invocations < 1:
             raise ValueError("max_invocations must be at least 1 or None.")
         if max_invocation_exceptions is not None and max_invocation_exceptions < 1:
@@ -965,8 +959,6 @@ def _parse_annotation(annotation: Any) -> Any:
 def _create_input_model_from_func(func: Callable[..., Any], name: str) -> type[BaseModel]:
     """Create a Pydantic model from a function's signature."""
     # Unwrap FunctionTool objects to get the underlying function
-    from agent_framework._tools import FunctionTool
-
     if isinstance(func, FunctionTool):
         func = func.func  # type: ignore[assignment]
 
@@ -1272,7 +1264,7 @@ def tool(
         description: A description of the function. If not provided, the function's
             docstring will be used.
         approval_mode: Whether or not approval is required to run this tool.
-            Default is that approval is not needed.
+            Default is that approval is required.
         max_invocations: The maximum number of times this function can be invoked.
             If None, there is no limit, should be at least 1.
         max_invocation_exceptions: The maximum number of exceptions allowed during invocations.
@@ -1293,7 +1285,7 @@ def tool(
             from typing import Annotated
 
 
-            @tool
+            @tool(approval_mode="never_require")
             def tool_example(
                 arg1: Annotated[str, "The first argument"],
                 arg2: Annotated[int, "The second argument"],
@@ -1319,7 +1311,7 @@ def another_weather_func(location: str) -> str:
 
 
             # Async functions are also supported
-            @tool
+            @tool(approval_mode="never_require")
             async def async_get_weather(location: str) -> str:
                 '''Get weather asynchronously.'''
                 # Simulate async operation

python/samples/README.md

@@ -292,6 +292,12 @@ These samples demonstrate durable agent hosting using the Durable Task Scheduler
 
 ## Tools
 
+Note: Many tool samples set `approval_mode="never_require"` to keep the examples concise. For production scenarios,
+keep `approval_mode="always_require"` unless you are confident in the tool behavior and approval flow. See
+`getting_started/tools/function_tool_with_approval.py` and
+`getting_started/tools/function_tool_with_approval_and_threads.py`, plus the workflow approval samples in
+`getting_started/workflows/tool-approval/`, for end-to-end approval handling.
+
 | File | Description |
 |------|-------------|
 | [`getting_started/tools/function_tool_declaration_only.py`](./getting_started/tools/function_tool_declaration_only.py) | Function declarations without implementations for testing agent reasoning |

python/samples/autogen-migration/orchestrations/01_round_robin_group_chat.py

@@ -103,6 +103,7 @@ async def run_agent_framework_with_cycle() -> None:
         WorkflowContext,
         WorkflowOutputEvent,
         executor,
+        tool,
     )
     from agent_framework.openai import OpenAIChatClient
 

python/samples/autogen-migration/orchestrations/03_swarm.py

@@ -102,6 +102,7 @@ async def run_agent_framework() -> None:
         RequestInfoEvent,
         WorkflowRunState,
         WorkflowStatusEvent,
+        tool,
     )
     from agent_framework.openai import OpenAIChatClient
 

python/samples/autogen-migration/orchestrations/04_magentic_one.py

@@ -63,6 +63,7 @@ async def run_agent_framework() -> None:
         MagenticBuilder,
         MagenticFinalResultEvent,
         MagenticOrchestratorMessageEvent,
+        tool,
     )
     from agent_framework.openai import OpenAIChatClient
 

python/samples/autogen-migration/single_agent/02_assistant_agent_with_tool.py

@@ -51,7 +51,8 @@ async def run_agent_framework() -> None:
     from agent_framework.openai import OpenAIChatClient
 
     # Define tool with @tool decorator (automatic schema inference)
-    @tool
+    # NOTE: approval_mode="never_require" is for sample brevity. Use "always_require" in production; see samples/getting_started/tools/function_tool_with_approval.py and samples/getting_started/tools/function_tool_with_approval_and_threads.py.
+    @tool(approval_mode="never_require")
     def get_weather(location: str) -> str:
         """Get the weather for a location.
 

python/samples/demos/chatkit-integration/app.py

@@ -19,6 +19,7 @@
 
 # Agent Framework imports
 from agent_framework import AgentResponseUpdate, ChatAgent, ChatMessage, FunctionResultContent, Role
+from agent_framework import tool
 from agent_framework.azure import AzureOpenAIChatClient
 
 # Agent Framework ChatKit integration
@@ -130,7 +131,8 @@ async def stream_widget(
 
     yield ThreadItemDoneEvent(type="thread.item.done", item=widget_item)
 
-
+# NOTE: approval_mode="never_require" is for sample brevity. Use "always_require" in production; see samples/getting_started/tools/function_tool_with_approval.py and samples/getting_started/tools/function_tool_with_approval_and_threads.py.
+@tool(approval_mode="never_require")
 def get_weather(
     location: Annotated[str, Field(description="The location to get the weather for.")],
 ) -> str:
@@ -168,14 +170,14 @@ def get_weather(
     )
     return WeatherResponse(text, weather_data)
 
-
+@tool(approval_mode="never_require")
 def get_time() -> str:
     """Get the current UTC time."""
     current_time = datetime.now(timezone.utc)
     logger.info("Getting current UTC time")
     return f"Current UTC time: {current_time.strftime('%Y-%m-%d %H:%M:%S')} UTC"
 
-
+@tool(approval_mode="never_require")
 def show_city_selector() -> str:
     """Show an interactive city selector widget to the user.
 

python/samples/demos/m365-agent/m365_agent_demo/app.py

@@ -17,6 +17,7 @@
 from typing import Annotated
 
 from agent_framework import ChatAgent
+from agent_framework import tool
 from agent_framework.openai import OpenAIChatClient
 from aiohttp import web
 from aiohttp.web_middlewares import middleware
@@ -76,7 +77,8 @@ def load_app_config() -> AppConfig:
         port = 3978
     return AppConfig(use_anonymous_mode=use_anonymous_mode, port=port, agents_sdk_config=agents_sdk_config)
 
-
+# NOTE: approval_mode="never_require" is for sample brevity. Use "always_require" in production; see samples/getting_started/tools/function_tool_with_approval.py and samples/getting_started/tools/function_tool_with_approval_and_threads.py.
+@tool(approval_mode="never_require")
 def get_weather(
     location: Annotated[str, Field(description="The location to get the weather for.")],
 ) -> str:

python/samples/demos/workflow_evaluation/create_workflow.py

@@ -57,6 +57,7 @@
     WorkflowOutputEvent,
     executor,
     handler,
+    tool,
 )
 from agent_framework.azure import AzureAIClient
 from azure.ai.projects.aio import AIProjectClient