Build and run agents you can see, understand and trust.
Python agentchatbotlarge-language-modelsllmllm-agentmcpmulti-agentmulti-modalreact-agentrealtime-agentvoice-agentvoice-assistant
fix(toolkit): fix meta tool failing to deactivate tool groups (#962)
DavdGao5bc937a771aa
diff --git a/docs/tutorial/en/src/quickstart_agent.py b/docs/tutorial/en/src/quickstart_agent.pyindex e58bf72e6..509efac6e 100644--- a/docs/tutorial/en/src/quickstart_agent.py+++ b/docs/tutorial/en/src/quickstart_agent.py@@ -79,7 +79,7 @@ from agentscope.tool import Toolkit, execute_python_code## - ``agent_control``: allow agent to control the long-term memory by itself# - ``static_control``: retrieving and recording from/to long-term memory will happen in the beginning/end of each reply.-# - ``both``: active the above two modes at the same time+# - ``both``: activate the above two modes at the same time# * - ``enable_meta_tool``# - :ref:`tool`# - Whether to enable the meta tool, which allows the agent to manage tools by itselfdiff --git a/src/agentscope/_utils/_common.py b/src/agentscope/_utils/_common.pyindex aa19a2548..e7008228c 100644--- a/src/agentscope/_utils/_common.py+++ b/src/agentscope/_utils/_common.py@@ -321,7 +321,7 @@ def _parse_tool_function(if include_long_description and docstring.long_description is not None:descriptions.append(docstring.long_description)- func_description = "\n\n".join(descriptions)+ func_description = "\n".join(descriptions)# Create a dynamic model with the function signaturefields = {}diff --git a/src/agentscope/_version.py b/src/agentscope/_version.pyindex b2b674ebc..cd2706a10 100644--- a/src/agentscope/_version.py+++ b/src/agentscope/_version.py@@ -1,4 +1,4 @@# -*- coding: utf-8 -*-"""The version of agentscope."""-__version__ = "1.0.8"+__version__ = "1.0.9dev"diff --git a/src/agentscope/tool/_toolkit.py b/src/agentscope/tool/_toolkit.pyindex 42eec3bd2..60abbb1c1 100644--- a/src/agentscope/tool/_toolkit.py+++ b/src/agentscope/tool/_toolkit.py@@ -624,8 +624,31 @@ Check "{dir}/SKILL.md" for how to use this skill"""None,)- # Prepare function and keyword arguments+ # Obtain the tool functiontool_func = self.tools[tool_call["name"]]++ # Check if the tool function is in an inactive group+ if (+ tool_func.group != "basic"+ and not self.groups[tool_func.group].active+ ):+ return _object_wrapper(+ ToolResponse(+ content=[+ TextBlock(+ type="text",+ text="FunctionInactiveError: The function "+ f"'{tool_call['name']}' is in the inactive "+ f"group '{tool_func.group}'. Activate the tool "+ "group by calling 'reset_equipped_tools' "+ "first to use this tool.",+ ),+ ],+ ),+ None,+ )++ # Prepare keyword argumentskwargs = {**tool_func.preset_kwargs,**(tool_call.get("input", {}) or {}),@@ -905,23 +928,28 @@ Check "{dir}/SKILL.md" for how to use this skill"""if group.active and group.notes:collected_notes.append("\n".join(- [f"## About {group_name} Tools", group.notes],+ [f"## About Tool Group '{group_name}'", group.notes],),)return "\n".join(collected_notes)def reset_equipped_tools(self, **kwargs: Any) -> ToolResponse:- """Choose appropriate tools to equip yourself with, so that you can- finish your task. Each argument in this function represents a group- of related tools, and the value indicates whether to activate the- group or not. Besides, the tool response of this function will- contain the precaution notes for using them, which you- **MUST pay attention to and follow**. You can also reuse this function- to check the notes of the tool groups.-- Note this function will `reset` the tools, so that the original tools- will be removed first.- """+ """This function allows you to activate or deactivate tool groups+ dynamically based on your current task requirements.+ **Important: Each call sets the absolute final state of ALL tool+ groups, not incremental changes**. Any group not explicitly set to True+ will be deactivated, regardless of its previous state.++ **Best practice**: Actively manage your tool groups——activate only+ what you need for the current task, and promptly deactivate groups as+ soon as they are no longer needed to conserve context space.++ The function will return the usage instructions for the activated tool+ groups, which you **MUST pay attention to and follow**. You can also+ reuse this function to check the notes of the tool groups."""++ # Deactivate all tool groups first+ self.update_tool_groups(list(self.groups.keys()), active=False)to_activate = []for key, value in kwargs.items():@@ -943,13 +971,28 @@ Check "{dir}/SKILL.md" for how to use this skill"""notes = self.get_activated_notes()+ text_response = ""+ if to_activate:+ text_response += (+ "Now tool groups "+ + ", ".join([f"'{_}'" for _ in to_activate])+ + " are activated."+ )++ if notes:+ text_response += (+ f" You MUST follow these notes to use these tools:\n"+ f"<notes>{notes}</notes>"+ )++ if not text_response:+ text_response = "All tool groups are now deactivated currently."+return ToolResponse(content=[TextBlock(type="text",- text=f"Active tool groups successfully: {to_activate}. "- "You MUST follow these notes to use the tools:\n"- f"<notes>{notes}</notes>",+ text=text_response,),],)diff --git a/tests/toolkit_test.py b/tests/toolkit_basic_test.pysimilarity index 86%rename from tests/toolkit_test.pyrename to tests/toolkit_basic_test.pyindex 9642d294e..cf689ec6c 100644--- a/tests/toolkit_test.py+++ b/tests/toolkit_basic_test.py@@ -1,6 +1,5 @@# -*- coding: utf-8 -*-# mypy: disable-error-code="index"-# pylint: disable=too-many-lines"""Test toolkit module in agentscope."""import asyncioimport time@@ -147,8 +146,8 @@ class ExtendedModelReusingBaseModel(BaseModel):extra_field: str = Field(description="Extra field")-class ToolkitTest(IsolatedAsyncioTestCase):- """Unittest for the toolkit module."""+class ToolkitBasicTest(IsolatedAsyncioTestCase):+ """Basic unittests for the toolkit module."""async def asyncSetUp(self) -> None:"""Set up the test environment before each test."""@@ -184,7 +183,7 @@ class ToolkitTest(IsolatedAsyncioTestCase):"required": ["arg1"],"type": "object",},- "description": "A sync function for testing.\n\n"+ "description": "A sync function for testing.\n""Long description.",},}@@ -396,7 +395,7 @@ class ToolkitTest(IsolatedAsyncioTestCase):"arg3",],},- "description": "A sync function for testing.\n\n"+ "description": "A sync function for testing.\n""Long description.",},},@@ -550,7 +549,7 @@ class ToolkitTest(IsolatedAsyncioTestCase):"properties": {},"type": "object",},- "description": "A test function.\n\n"+ "description": "A test function.\n""Note this function is test.",},},@@ -810,7 +809,7 @@ class ToolkitTest(IsolatedAsyncioTestCase):[],)- # Active the tool group+ # Activate the tool groupself.toolkit.update_tool_groups(["my_group"], True)self.assertListEqual(self.toolkit.get_json_schemas(),@@ -975,113 +974,6 @@ class ToolkitTest(IsolatedAsyncioTestCase):"Received: a=1, b=test, c=[1, 2, 3], d=xyz",)- async def test_meta_tool(self) -> None:- """Test the meta tool."""- self.toolkit.register_tool_function(- self.toolkit.reset_equipped_tools,- )- self.assertListEqual(- self.toolkit.get_json_schemas(),- [- {- "type": "function",- "function": {- "name": "reset_equipped_tools",- "parameters": {- "properties": {},- "type": "object",- },- "description": (- "Choose appropriate tools to equip yourself "- "with, so that you can\n\n"- "finish your task. Each argument in this function "- "represents a group\n"- "of related tools, and the value indicates "- "whether to activate the\n"- "group or not. Besides, the tool response of "- "this function will\n"- "contain the precaution notes for using them, "- "which you\n"- "**MUST pay attention to and follow**. You can "- "also reuse this function\n"- "to check the notes of the tool groups.\n\n"- "Note this function will `reset` the tools, so "- "that the original tools\n"- "will be removed first."- ),- },- },- ],- )- self.toolkit.create_tool_group(- "browser_use",- "The browser-use related tools.",- notes="""## About Browser-Use Tools-1. You must xxx-2. First click xxx-""",- )- self.assertListEqual(- self.toolkit.get_json_schemas(),- [- {- "type": "function",- "function": {- "name": "reset_equipped_tools",- "parameters": {- "properties": {- "browser_use": {- "default": False,- "description": "The browser-use related "- "tools.",- "type": "boolean",- },- },- "type": "object",- },- "description": (- "Choose appropriate tools to equip yourself "- "with, so that you can\n\n"- "finish your task. Each argument in this function "- "represents a group\n"- "of related tools, and the value indicates "- "whether to activate the\n"- "group or not. Besides, the tool response of "- "this function will\n"- "contain the precaution notes for using them, "- "which you\n"- "**MUST pay attention to and follow**. You can "- "also reuse this function\n"- "to check the notes of the tool groups.\n\n"- "Note this function will `reset` the tools, so "- "that the original tools\n"- "will be removed first."- ),- },- },- ],- )- res = await self.toolkit.call_tool_function(- ToolUseBlock(- type="tool_use",- id="123",- name="reset_equipped_tools",- input={"browser_use": True},- ),- )-- async for chunk in res:- self.assertEqual(- chunk.content[0]["text"],- "Active tool groups successfully: ['browser_use']. "- "You MUST follow these notes to use the tools:\n"- "<notes>## About browser_use Tools\n"- "## About Browser-Use Tools\n"- "1. You must xxx\n"- "2. First click xxx\n"- "</notes>",- )-async def asyncTearDown(self) -> None:"""Clean up after each test."""self.toolkit = Nonediff --git a/tests/toolkit_meta_tool_test.py b/tests/toolkit_meta_tool_test.pynew file mode 100644index 000000000..38334cb49--- /dev/null+++ b/tests/toolkit_meta_tool_test.py@@ -0,0 +1,276 @@+# -*- coding: utf-8 -*-+# mypy: disable-error-code="index"+"""Test meta tool in toolkit module in agentscope."""+from unittest import IsolatedAsyncioTestCase++from agentscope.message import ToolUseBlock, TextBlock+from agentscope.tool import ToolResponse, Toolkit+++def tool_function_1() -> ToolResponse:+ """Test tool function 1."""+ return ToolResponse(+ content=[+ TextBlock(+ type="text",+ text="1",+ ),+ ],+ )+++def tool_function_2() -> ToolResponse:+ """Test tool function 2."""+ return ToolResponse(+ content=[+ TextBlock(+ type="text",+ text="2",+ ),+ ],+ )+++class ToolkitMetaToolTest(IsolatedAsyncioTestCase):+ """Unittest for the toolkit module."""++ async def asyncSetUp(self) -> None:+ """Set up the test environment before each test."""+ self.toolkit = Toolkit()++ self.function_1_schema = {+ "type": "function",+ "function": {+ "name": "tool_function_1",+ "parameters": {+ "type": "object",+ "properties": {},+ },+ "description": "Test tool function 1.",+ },+ }++ self.function_2_schema = {+ "type": "function",+ "function": {+ "name": "tool_function_2",+ "parameters": {+ "type": "object",+ "properties": {},+ },+ "description": "Test tool function 2.",+ },+ }++ self.meta_tool_schema = {+ "type": "function",+ "function": {+ "name": "reset_equipped_tools",+ "parameters": {+ "properties": {},+ "type": "object",+ },+ "description": """This function allows you to activate or \+deactivate tool groups+dynamically based on your current task requirements.+**Important: Each call sets the absolute final state of ALL tool+groups, not incremental changes**. Any group not explicitly set to True+will be deactivated, regardless of its previous state.++**Best practice**: Actively manage your tool groups——activate only+what you need for the current task, and promptly deactivate groups as+soon as they are no longer needed to conserve context space.++The function will return the usage instructions for the activated tool+groups, which you **MUST pay attention to and follow**. You can also+reuse this function to check the notes of the tool groups.""",+ },+ }++ async def test_meta_tool(self) -> None:+ """Test the meta tool."""+ self.toolkit.register_tool_function(+ self.toolkit.reset_equipped_tools,+ )++ # Test if the meta tool is registered correctly+ self.assertListEqual(+ self.toolkit.get_json_schemas(),+ [self.meta_tool_schema],+ )++ # Test creating a tool group and using the meta tool+ self.toolkit.create_tool_group(+ "browser_use",+ "The browser-use related tools.",+ notes="""1. You must xxx+2. First click xxx+""",+ )+ self.toolkit.register_tool_function(+ tool_function_1,+ group_name="browser_use",+ )++ self.meta_tool_schema["function"]["parameters"]["properties"] = {+ "browser_use": {+ "type": "boolean",+ "description": "The browser-use related tools.",+ "default": False,+ },+ }++ # Test if the arguments are updated correctly+ self.assertListEqual(+ self.toolkit.get_json_schemas(),+ [+ self.meta_tool_schema,+ ],+ )++ res = await self.toolkit.call_tool_function(+ ToolUseBlock(+ type="tool_use",+ id="123",+ name="reset_equipped_tools",+ input={"browser_use": True},+ ),+ )++ # Test if the tool response is correct+ async for chunk in res:+ self.assertEqual(+ chunk.content[0]["text"],+ "Now tool groups 'browser_use' are activated. "+ "You MUST follow these notes to use these tools:\n"+ "<notes>## About Tool Group 'browser_use'\n"+ "1. You must xxx\n"+ "2. First click xxx\n"+ "</notes>",+ )++ # Test if the tool group is activated correctly, i.e. the tool+ # function 1 is available+ self.assertListEqual(+ self.toolkit.get_json_schemas(),+ [+ self.meta_tool_schema,+ {+ "type": "function",+ "function": {+ "name": "tool_function_1",+ "parameters": {+ "type": "object",+ "properties": {},+ },+ "description": "Test tool function 1.",+ },+ },+ ],+ )++ # Create another tool group and register tool function 2+ self.toolkit.create_tool_group(+ "file_use",+ "The file-use related tools.",+ )+ self.toolkit.register_tool_function(+ tool_function_2,+ group_name="file_use",+ )++ # Test if the meta tool schema is updated correctly+ self.meta_tool_schema["function"]["parameters"]["properties"] = {+ "browser_use": {+ "type": "boolean",+ "description": "The browser-use related tools.",+ "default": False,+ },+ "file_use": {+ "type": "boolean",+ "description": "The file-use related tools.",+ "default": False,+ },+ }++ self.assertListEqual(+ self.toolkit.get_json_schemas(),+ [+ self.meta_tool_schema,+ self.function_1_schema,+ ],+ )++ # Activate the file-use tool group only+ res = await self.toolkit.call_tool_function(+ ToolUseBlock(+ type="tool_use",+ id="124",+ name="reset_equipped_tools",+ input={"file_use": True},+ ),+ )++ # Test if the tool response is correct+ async for chunk in res:+ self.assertEqual(+ chunk.content[0]["text"],+ "Now tool groups 'file_use' are activated.",+ )++ # Test if only tool function 2 is available now+ self.assertListEqual(+ self.toolkit.get_json_schemas(),+ [+ self.meta_tool_schema,+ self.function_2_schema,+ ],+ )++ # Test if all tool groups are deactivated+ res = await self.toolkit.call_tool_function(+ ToolUseBlock(+ type="tool_use",+ id="125",+ name="reset_equipped_tools",+ input={},+ ),+ )++ # Test if the tool response is correct+ async for chunk in res:+ self.assertEqual(+ chunk.content[0]["text"],+ "All tool groups are now deactivated currently.",+ )++ # Test if no tool function is available now+ self.assertListEqual(+ self.toolkit.get_json_schemas(),+ [+ self.meta_tool_schema,+ ],+ )++ # Test calling the inactive tool function+ res = await self.toolkit.call_tool_function(+ ToolUseBlock(+ type="tool_use",+ id="126",+ name="tool_function_1",+ input={},+ ),+ )++ async for chunk in res:+ self.assertEqual(+ chunk.content[0]["text"],+ "FunctionInactiveError: The function 'tool_function_1' "+ "is in the inactive group 'browser_use'. "+ "Activate the tool group by calling 'reset_equipped_tools' "+ "first to use this tool.",+ )++ async def asyncTearDown(self) -> None:+ """Clean up after each test."""+ self.toolkit = None