fix: move metadata to tool def

This change allows the following flow to work: parse file with metadata
-> run the result tools.

Signed-off-by: Donnie Adams <[email protected]>

Author: thedadams

gptscript/run.py

@@ -85,12 +85,24 @@ def next_chat(self, input: str = "") -> Self:
         run.opts.input = input
         if isinstance(run.tools, list):
             run._task = asyncio.create_task(
-                run._request({"toolDefs": [tool.to_json() for tool in run.tools], **vars(run.opts)}))
+                run._request({
+                    "toolDefs": [
+                        tool.to_json().get("toolNode", {}).get("tool", {}) if isinstance(tool, Tool) else tool.to_json()
+                        for tool in run.tools
+                    ], **vars(run.opts)
+                })
+            )
         elif isinstance(run.tools, str) and run.tools != "":
             run._task = asyncio.create_task(run._request({"file": run.tools, **vars(run.opts)}))
         elif isinstance(run.tools, ToolDef) or isinstance(run.tools, Tool):
             # In this last case, this.tools is a single ToolDef.
-            run._task = asyncio.create_task(run._request({"toolDefs": [run.tools.to_json()], **vars(run.opts)}))
+            run._task = asyncio.create_task(run._request({
+                "toolDefs": [
+                    run.tools.to_json().get("toolNode", {}).get("tool", {})
+                    if isinstance(run.tools, Tool) else run.tools.to_json()
+                ],
+                **vars(run.opts)
+            }))
         else:
             run._task = asyncio.create_task(run._request({**vars(run.opts)}))
 

gptscript/tool.py

@@ -60,6 +60,7 @@ def __init__(self,
                  credentials: list[str] = None,
                  instructions: str = "",
                  type: str = "",
+                 metaData: dict[str, str] = None,
                  ):
         self.name = name
         self.description = description
@@ -85,6 +86,7 @@ def __init__(self,
         self.credentials = credentials
         self.instructions = instructions
         self.type = type
+        self.metaData = metaData
 
     def to_json(self) -> dict[str, Any]:
         out = self.__dict__
@@ -164,15 +166,15 @@ def __init__(self,
                  credentials: list[str] = None,
                  instructions: str = "",
                  type: str = "",
-                 toolMapping: dict[str, list[ToolReference]] = None,
                  metaData: dict[str, str] = None,
+                 toolMapping: dict[str, list[ToolReference]] = None,
                  localTools: dict[str, str] = None,
                  source: SourceRef = None,
                  workingDir: str = "",
                  ):
         super().__init__(name, description, maxTokens, modelName, modelProvider, jsonResponse, temperature, cache, chat,
                          internalPrompt, arguments, tools, globalTools, globalModelName, context, exportContext, export,
-                         agents, credentials, instructions, type)
+                         agents, credentials, instructions, type, metaData)
 
         self.id = id
         self.toolMapping = toolMapping
@@ -183,7 +185,6 @@ def __init__(self,
                         if isinstance(self.toolMapping[tool][i], dict):
                             self.toolMapping[tool][i] = ToolReference(**self.toolMapping[tool][i])
         self.localTools = localTools
-        self.metaData = metaData
         self.source = source
         if self.source is not None and isinstance(self.source, dict):
             self.source = SourceRef(**self.source)

tests/test_gptscript.py

@@ -351,8 +351,8 @@ async def test_tool_chat(gptscript):
 async def test_file_chat(gptscript):
     inputs = [
         "List the 3 largest of the Great Lakes by volume.",
-        "What is the volume of the second one in cubic miles?",
-        "What is the total area of the third one in square miles?",
+        "What is the volume of the second in the list in cubic miles?",
+        "What is the total area of the third in the list in square miles?",
     ]
     expected_outputs = [
         "Lake Superior",
@@ -540,6 +540,14 @@ def test_get_env():
 
 
 @pytest.mark.asyncio
-async def test_stream_run_file(gptscript):
+async def test_run_file_with_metadata(gptscript):
     run = gptscript.run("./tests/fixtures/parse-with-metadata.gpt")
     assert "200" == await run.text(), "Expect file to have correct output"
+
+
+@pytest.mark.asyncio
+async def test_parse_with_metadata_then_run(gptscript):
+    cwd = os.getcwd().removesuffix("tests")
+    tools = await gptscript.parse(cwd + "/tests/fixtures/parse-with-metadata.gpt")
+    run = gptscript.evaluate(tools[0])
+    assert "200" == await run.text(), "Expect file to have correct output"