fix(tools): enforce strict array typing for runTool method arguments

Author: Mark-H

core/components/modai/src/API/Tools/Run.php

@@ -2,6 +2,7 @@
 
 namespace modAI\API\Tools;
 
+use JsonException;
 use modAI\API\API;
 use modAI\Exceptions\APIException;
 use modAI\Exceptions\LexiconException;
@@ -50,10 +51,16 @@ public function post(ServerRequestInterface $request): void
             if (isset($tools[$toolCall['name']])) {
                 $tool = $tools[$toolCall['name']]->getToolInstance();
 
+                try {
+                    $arguments = (array) json_decode($toolCall['arguments'], true, 512, JSON_THROW_ON_ERROR);
+                } catch (JsonException) {
+                    $arguments = [];
+                }
+
                 $content[] = [
                     'id' => $toolCall['id'],
                     'name' => $toolCall['name'],
-                    'content' => $tool->runTool(json_decode($toolCall['arguments'], true)),
+                    'content' => $tool->runTool($arguments),
                 ];
             }
         }

core/components/modai/src/Tools/CreateCategory.php

@@ -68,7 +68,7 @@ public function __construct(modX $modx, array $config)
      * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);

core/components/modai/src/Tools/CreateChunk.php

@@ -69,7 +69,7 @@ public function __construct(modX $modx, array $config)
      * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);

core/components/modai/src/Tools/CreateResource.php

@@ -69,7 +69,7 @@ public function __construct(modX $modx, array $config)
      * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);

core/components/modai/src/Tools/CreateTemplate.php

@@ -69,7 +69,7 @@ public function __construct(modX $modx, array $config)
      * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);

core/components/modai/src/Tools/EditChunk.php

@@ -62,7 +62,7 @@ public function __construct(modX $modx, array $config)
      * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);

core/components/modai/src/Tools/EditTemplate.php

@@ -62,7 +62,7 @@ public function __construct(modX $modx, array $config)
      * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);

core/components/modai/src/Tools/GetCategories.php

@@ -35,10 +35,10 @@ public function __construct(modX $modx, array $config)
     }
 
     /**
-     * @param array | null $arguments
+     * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);

core/components/modai/src/Tools/GetChunks.php

@@ -63,10 +63,10 @@ public function __construct(modX $modx, array $config)
     }
 
     /**
-     * @param array | null $arguments
+     * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);

core/components/modai/src/Tools/GetResourceDetail.php

@@ -49,10 +49,10 @@ public function __construct(modX $modx, array $config)
     }
 
     /**
-     * @param array | null $arguments
+     * @param array $arguments
      * @return string
      */
-    public function runTool($arguments): string
+    public function runTool(array $arguments): string
     {
         if (!self::checkPermissions($this->modx)) {
             return json_encode(['success' => false, "message" => "You do not have permission to use this tool."]);