chore: sys.read: improve description (#834)

Signed-off-by: Grant Linville <[email protected]>
gptscript-ai · Sep 3, 2024 · 1d2b70c · 1d2b70c
1 parent 1ad818b
commit 1d2b70c
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/pkg/builtin/builtin.go b/pkg/builtin/builtin.go
@@ -59,7 +59,7 @@ var tools = map[string]types.Tool{
 	"sys.read": {
 		ToolDef: types.ToolDef{
 			Parameters: types.Parameters{
-				Description: "Reads the contents of a file",
+				Description: "Reads the contents of a file. Can only read plain text files, not binary files",
 				Arguments: types.ObjectSchema(
 					"filename", "The name of the file to read"),
 			},

diff --git a/pkg/tests/testdata/TestToolsChange/call1.golden b/pkg/tests/testdata/TestToolsChange/call1.golden
@@ -22,7 +22,7 @@
       "function": {
         "toolID": "sys.read",
         "name": "read",
-        "description": "Reads the contents of a file",
+        "description": "Reads the contents of a file. Can only read plain text files, not binary files",
         "parameters": {
           "properties": {
             "filename": {

diff --git a/pkg/tests/testdata/TestToolsChange/step1.golden b/pkg/tests/testdata/TestToolsChange/step1.golden
@@ -30,7 +30,7 @@
               "function": {
                 "toolID": "sys.read",
                 "name": "read",
-                "description": "Reads the contents of a file",
+                "description": "Reads the contents of a file. Can only read plain text files, not binary files",
                 "parameters": {
                   "properties": {
                     "filename": {