Validate tool call arguments

Author: Reason-Wang

agents/agents/tools/src/react/tools.py

@@ -1,7 +1,7 @@
 from ...tool_base import tool
 
 @tool(name="answer", description="Give the final answer. The answer should be put inside the \\boxed{} tag.", status="finish")
-def answer_math(answer: str):
+def answer(answer: str):
     """
     A helper tool to give the final answer. The answer should be put inside the \\boxed{} tag.
     Args:
@@ -11,8 +11,18 @@ def answer_math(answer: str):
     """
     return str(answer)
 
+@tool(name="answer_math", description="Give the final answer. The answer should be put inside the \\boxed{} tag.", status="finish")
+def answer_math(answer: str):
+    """
+    A helper tool to give the final answer. The answer should be put inside the \\boxed{} tag.
+    Args:
+        answer (str): The final answer to the question.
+    Returns:
+        str: The final answer to the question.
+    """
+    return str(answer)
 
-@tool(name="answer", description="Give the final answer. The answer should be a simple, short, and direct.", status="finish")
+@tool(name="answer_qa", description="Give the final answer. The answer should be a simple, short, and direct.", status="finish")
 def answer_qa(answer: str):
     """
     A helper tool to give the final answer. The answer should be a simple, short, and direct.

agents/agents/tools/tool_base.py

@@ -42,6 +42,7 @@ def __init__(
         name: str | None = None,
         description: str | None = None,
         schema: dict | None = None,
+        args: dict | None = None,
         max_length: int = 2048,
         env_cls: type[BaseEnv] | None = None,
         env_kwargs: dict | None = None,
@@ -54,6 +55,7 @@ def __init__(
         self.name = name or func.__name__
         self.description = description or ""
         self.schema = schema
+        self.args = args
         self.max_length = max_length
         self.status = status
 
@@ -87,6 +89,14 @@ def used_env_size(self):
             return len(self._envs)
         return 0
 
+    def _validate_call_args(self, kwargs):
+        # TODO: raise error, return error message, or filter the invalid arguments, make it configurable. Currently, we just return the error message.
+        for arg in kwargs:
+            if arg not in self.args:
+                # raise ValueError(f"""Invalid argument "{arg}" for tool {self.name}.""")
+                result = f"""Invalid argument "{arg}" for tool {self.name}."""
+                return result
+        return None
 
     async def __call__(self, **kwargs):
         """
@@ -101,30 +111,38 @@ async def __call__(self, **kwargs):
                 - "status": The status of the tool call.
                 - "info": The info of the tool call.
         """
-        try:
-            if not self.is_stateful:
-                # For non-stateful tools, directly execute the function
-                result = await self.user_func(**kwargs) if inspect.iscoroutinefunction(self.user_func) \
-                        else self.user_func(**kwargs)
-            else:
-                # For stateful tools, handle environment management
-                id = kwargs.pop('id', None)
-                if id is None:
-                    result = "Error: 'id' parameter is required for stateful tools"
+        # Check arguments before calling the tool
+        result = self._validate_call_args(kwargs)
+
+        # If the arguments are valid, call the tool
+        if result is None:
+            try:
+                if not self.is_stateful:
+                    # For non-stateful tools, directly execute the function
+                    result = await self.user_func(**kwargs) if inspect.iscoroutinefunction(self.user_func) \
+                            else self.user_func(**kwargs)
                 else:
-                    await self._initialize_envs()
-                    env = await self._acquire_env(id)
-                    
-                    async with self._locks[id]:
-                        # token = current_env.set(env)
-                        assert kwargs.get("env", None) is None, "env is not allowed to be passed to stateful tools"
-                        try:
-                            result = await self.user_func(env=env,**kwargs) if inspect.iscoroutinefunction(self.user_func) \
-                                  else self.user_func(**kwargs)
-                        finally:
-                            pass
-        except Exception as e:
-            result = str(e)
+                    # For stateful tools, handle environment management
+                    id = kwargs.pop('id', None)
+                    if id is None:
+                        result = "Error: 'id' parameter is required for stateful tools"
+                    else:
+                        await self._initialize_envs()
+                        env = await self._acquire_env(id)
+                        
+                        async with self._locks[id]:
+                            # token = current_env.set(env)
+                            assert kwargs.get("env", None) is None, "env is not allowed to be passed to stateful tools"
+                            try:
+                                result = await self.user_func(env=env,**kwargs) if inspect.iscoroutinefunction(self.user_func) \
+                                    else self.user_func(**kwargs)
+                            finally:
+                                pass
+            except Exception as e:
+                result = str(e)
+        # If the arguments are invalid, simply use the result from the validation
+        else:
+            pass
 
         # Result must be a string or a dict
         if isinstance(result, str):
@@ -258,15 +276,16 @@ def decorator(func):
         signature  = extract_signatures(func)
         docs       = parse_docstring(inspect.getdoc(func))
         final_desc = description or docs.get("summary", "")
-        final_schema = validate_schema(final_name, final_desc, signature, docs)
+        validated_schema = validate_schema(final_name, final_desc, signature, docs)
 
         # Create the tool
         def factory():
             return Tool(
                 func=func,
                 name=final_name,
                 description=final_desc,
-                schema=final_schema,
+                schema=validated_schema["schema"],
+                args=validated_schema["args"],
                 max_length=max_length,
                 env_cls=env_cls,
                 env_kwargs=env_kwargs,

agents/agents/tools/utils/schema.py

@@ -1,7 +1,7 @@
 import re
 import inspect
 import warnings
-
+from copy import deepcopy
 
 def extract_signatures(func):
     sig = inspect.signature(func)
@@ -185,7 +185,14 @@ def validate_schema(name, description, signature, docs):
             }
         }
     }
-    return schema
+    arguments = deepcopy(signature)
+    if "env" in arguments:
+        del arguments["env"]
+
+    return {
+        "schema": schema,
+        "args": arguments
+    }
 
 if __name__ == '__main__':
     # Retrieve and parse the docstring using inspect.

agents/tests/unit/tools/test_tool_functionality.py

@@ -0,0 +1,13 @@
+import pytest
+from agents.tools import tool
+
+
+@pytest.mark.asyncio
+async def test_args_validation():
+    @tool(name="add", description="Adds two numbers.")
+    async def add(a, b):
+        return a + b
+    
+    result = await add(a=1, b=2, c=3)
+    assert result == {"name": "add", "arguments": {"a": 1, "b": 2, "c": 3}, "observation": "Invalid argument \"c\" for tool add.", "status": "success", "info": {}}
+