feat: allow to customize tool's prompt

theboxer · theboxer · commit 3bcb3d27304f · 2025-04-18T21:13:02.000+02:00
diff --git a/assets/components/modai/mgr/css/modai.css b/assets/components/modai/mgr/css/modai.css
@@ -16,3 +16,10 @@
 .modai-admin--invalid_row {
     background-color: #ffeaea;
 }
+
+.modai-admin-label_button {
+    background-color: transparent;
+    padding: 0;
+    border: none;
+    cursor: pointer;
+}
diff --git a/assets/components/modai/mgr/js/tool/panel.js b/assets/components/modai/mgr/js/tool/panel.js
@@ -22,6 +22,95 @@ modAIAdmin.panel.Tool = function (config) {
     items: configItems,
   });
 
+  this.promptField = new Ext.form.TextArea({
+    fieldLabel: _('modai.admin.tool.prompt'),
+    name: 'prompt',
+    msgTarget: 'under',
+    value: config.record.prompt || config.record.defaultPrompt,
+    disabled: !config.record.prompt,
+    allowBlank: true,
+    grow: true,
+    defaultPrompt: config.record.defaultPrompt,
+    editBtn: null,
+    resetBtn: null,
+    renderEditButton: function() {
+      if (this.editBtn) {
+        return;
+      }
+
+      const btn = document.createElement('button');
+      btn.type = 'button';
+      btn.className = 'modai-admin-label_button';
+      btn.title = 'Edit Prompt';
+      btn.addEventListener('click', () => {
+        this.enable();
+        btn.remove();
+        this.editBtn = null;
+
+        this.renderResetButton();
+      });
+
+      const i = document.createElement('i');
+      i.className = 'icon icon-edit';
+      btn.appendChild(i);
+
+      this.editBtn = btn;
+      this.label.dom.append(btn);
+    },
+    renderResetButton: function() {
+      if (this.resetBtn) {
+        return;
+      }
+
+      const btn = document.createElement('button');
+      btn.type = 'button';
+      btn.className = 'modai-admin-label_button';
+      btn.title = 'Reset to the default Prompt';
+      btn.addEventListener('click', () => {
+        this.setValue(this.defaultPrompt)
+        this.disable();
+        btn.remove();
+        this.resetBtn = null;
+
+        this.renderEditButton();
+      });
+
+      const i = document.createElement('i');
+      i.className = 'icon icon-refresh';
+      btn.appendChild(i);
+
+      this.resetBtn = btn;
+      this.label.dom.append(btn);
+    },
+    initPrompt: function(prompt, defaultPrompt) {
+      this.defaultPrompt = defaultPrompt;
+      if (this.editBtn) {
+        this.editBtn.remove();
+        this.editBtn = null;
+      }
+
+      if (this.resetBtn) {
+        this.resetBtn.remove();
+        this.resetBtn = null;
+      }
+
+      if (prompt) {
+        this.setValue(prompt);
+        this.renderResetButton();
+        return;
+      }
+
+      this.disable();
+      this.setValue(this.defaultPrompt);
+      this.renderEditButton();
+    },
+    listeners: {
+      afterrender: function () {
+        this.initPrompt(config.record.prompt, config.record.defaultPrompt);
+      }
+    }
+  });
+
   Ext.applyIf(config, {
     border: false,
     cls: 'container',
@@ -44,6 +133,7 @@ modAIAdmin.panel.Tool = function (config) {
 
 Ext.extend(modAIAdmin.panel.Tool, MODx.FormPanel, {
   configSection: null,
+  promptField: null,
 
   success: function (o, r) {
     if (this.config.isUpdate === false) {
@@ -136,6 +226,8 @@ Ext.extend(modAIAdmin.panel.Tool, MODx.FormPanel, {
                           description.setValue(record.data.description);
                         }
 
+                        this.promptField.initPrompt(undefined, record.data.defaultPrompt);
+
                         this.configSection.removeAll();
                         Object.entries(record.data.config).forEach(([key, config]) => {
                           this.configSection.add(modAIAdmin.formatConfigItem(key, config));
@@ -154,13 +246,14 @@ Ext.extend(modAIAdmin.panel.Tool, MODx.FormPanel, {
                     value: config.record.name,
                   },
                   {
-                    fieldLabel: _('modai.admin.context_provider.description'),
+                    fieldLabel: _('modai.admin.tool.description'),
                     xtype: 'textarea',
                     name: 'description',
                     msgTarget: 'under',
                     value: config.record.description,
                     allowBlank: true,
                   },
+                  this.promptField
                 ],
               },
 
diff --git a/assets/components/modai/mgr/js/utils/combos.js b/assets/components/modai/mgr/js/utils/combos.js
@@ -162,7 +162,7 @@ modAIAdmin.combo.ToolClass = function (config) {
         hiddenName: 'class',
         displayField: 'class',
         valueField: 'class',
-        fields: ['class', 'config', 'suggestedName', 'description'],
+        fields: ['class', 'config', 'suggestedName', 'description', 'defaultPrompt'],
         typeAhead: false,
         editable: true,
         forceSelection: true,
diff --git a/core/components/modai/controllers/tool/update.class.php b/core/components/modai/controllers/tool/update.class.php
@@ -22,6 +22,7 @@ public function process(array $scriptProperties = [])
 
         $this->toolData = $tool->toArray();
         $this->toolData['classConfig'] = $this->toolData['class']::getConfig($this->modx);
+        $this->toolData['defaultPrompt'] = $this->toolData['class']::getPrompt();
     }
 
     public function getPageTitle()
diff --git a/core/components/modai/lexicon/en/default.inc.php b/core/components/modai/lexicon/en/default.inc.php
@@ -45,6 +45,7 @@
 $_lang['modai.admin.tool.class'] = "Tool Class";
 $_lang['modai.admin.tool.tool'] = 'Tool';
 $_lang['modai.admin.tool.agents'] = 'Agents';
+$_lang['modai.admin.tool.prompt'] = 'Prompt';
 
 $_lang['modai.admin.agent.name'] = 'Name';
 $_lang['modai.admin.agent.description'] = 'Description';
diff --git a/core/components/modai/schema/modai.mysql.schema.xml b/core/components/modai/schema/modai.mysql.schema.xml
@@ -68,6 +68,7 @@
         <field key="class" dbtype="varchar" precision="200" phptype="string" null="false" />
         <field key="name" dbtype="varchar" precision="200" phptype="string" null="false" />
         <field key="description" dbtype="varchar" precision="500" phptype="string" null="true" default="" />
+        <field key="prompt" dbtype="text" phptype="string" null="true" />
         <field key="config" dbtype="text" phptype="json" null="true" />
         <field key="enabled" dbtype="tinyint" precision="1" phptype="boolean" null="false" default="0" />
         <field key="default" dbtype="tinyint" precision="1" phptype="boolean" null="false" default="0" />
diff --git a/core/components/modai/src/Model/mysql/Tool.php b/core/components/modai/src/Model/mysql/Tool.php
@@ -19,6 +19,7 @@ class Tool extends \modAI\Model\Tool
             'class' => NULL,
             'name' => NULL,
             'description' => '',
+            'prompt' => NULL,
             'config' => NULL,
             'enabled' => 0,
             'default' => 0,
@@ -47,6 +48,12 @@ class Tool extends \modAI\Model\Tool
                 'null' => true,
                 'default' => '',
             ),
+            'prompt' => 
+            array (
+                'dbtype' => 'text',
+                'phptype' => 'string',
+                'null' => true,
+            ),
             'config' => 
             array (
                 'dbtype' => 'text',
diff --git a/core/components/modai/src/Processors/Combos/ToolClass.php b/core/components/modai/src/Processors/Combos/ToolClass.php
@@ -46,6 +46,7 @@ public function process()
                 'config' => $class::getConfig($this->modx),
                 'suggestedName' => $class::getSuggestedName(),
                 'description' => $class::getDescription(),
+                'defaultPrompt' => $class::getPrompt(),
             ];
         }, $classes), count($classes));
     }
diff --git a/core/components/modai/src/Processors/ContextProviders/Create.php b/core/components/modai/src/Processors/ContextProviders/Create.php
@@ -38,7 +38,7 @@ public function beforeSet()
             return false;
         }
 
-        $config = $class::getConfig();
+        $config = $class::getConfig($this->modx);
         $configValues = [];
         foreach ($config as $key => $options) {
             $configValues[$key] = $this->getProperty("config_$key");
diff --git a/core/components/modai/src/Processors/ContextProviders/Update.php b/core/components/modai/src/Processors/ContextProviders/Update.php
@@ -38,7 +38,7 @@ public function beforeSet()
             return false;
         }
 
-        $config = $class::getConfig();
+        $config = $class::getConfig($this->modx);
         $configValues = [];
         foreach ($config as $key => $options) {
             $configValues[$key] = $this->getProperty("config_$key");
diff --git a/core/components/modai/src/Processors/Tools/Create.php b/core/components/modai/src/Processors/Tools/Create.php
@@ -38,7 +38,7 @@ public function beforeSet()
             return false;
         }
 
-        $config = $class::getConfig();
+        $config = $class::getConfig($this->modx);
         $configValues = [];
         foreach ($config as $key => $options) {
             $configValues[$key] = $this->getProperty("config_$key");
@@ -50,6 +50,11 @@ public function beforeSet()
 
         $this->setProperty('config', empty($configValues) ? null : $configValues);
 
+        $prompt = $this->getProperty('prompt');
+        if (empty($prompt)) {
+            $this->setProperty('prompt', null);
+        }
+
         return parent::beforeSet();
     }
 }
diff --git a/core/components/modai/src/Processors/Tools/Update.php b/core/components/modai/src/Processors/Tools/Update.php
@@ -38,7 +38,7 @@ public function beforeSet()
             return false;
         }
 
-        $config = $class::getConfig();
+        $config = $class::getConfig($this->modx);
         $configValues = [];
         foreach ($config as $key => $options) {
             $configValues[$key] = $this->getProperty("config_$key");
@@ -50,6 +50,11 @@ public function beforeSet()
 
         $this->setProperty('config', empty($configValues) ? null : $configValues);
 
+        $prompt = $this->getProperty('prompt');
+        if (empty($prompt)) {
+            $this->setProperty('prompt', null);
+        }
+
         return parent::beforeSet();
     }
 }
diff --git a/core/components/modai/src/Services/Anthropic.php b/core/components/modai/src/Services/Anthropic.php
@@ -192,10 +192,8 @@ public function getCompletions(array $data, CompletionsConfig $config): AIRespon
         }
 
         $tools = [];
-        foreach ($config->getTools() as $toolName => $tool) {
-            /** @var class-string<ToolInterface> $toolClass */
-            $toolClass = $tool->get('class');
-            $params = $toolClass::getParameters();
+        foreach ($config->getTools() as $tool) {
+            $params = $tool['parameters'];
 
             if (empty($params)) {
                 $params = [
@@ -205,8 +203,8 @@ public function getCompletions(array $data, CompletionsConfig $config): AIRespon
             }
 
             $tools[] = [
-                'name' => $toolName,
-                'description' => $toolClass::getPrompt(),
+                'name' => $tool['name'],
+                'description' => $tool['description'],
                 'input_schema' => (object)$params,
             ];
         }
diff --git a/core/components/modai/src/Services/Config/CompletionsConfig.php b/core/components/modai/src/Services/Config/CompletionsConfig.php
@@ -3,6 +3,7 @@
 namespace modAI\Services\Config;
 
 use modAI\Model\Tool;
+use modAI\Tools\ToolInterface;
 
 class CompletionsConfig
 {
@@ -90,11 +91,24 @@ public function getMessages(): array
     }
 
     /**
-     * @return array<string, Tool>
+     * @return array<int, array{name: string, description: string, parameters: array}>
      */
     public function getTools(): array
     {
-        return $this->tools;
+        $tools = [];
+        foreach ($this->tools as $toolName => $tool) {
+            /** @var class-string<ToolInterface> $toolClass */
+            $toolClass = $tool->get('class');
+
+            $prompt = $tool->get('prompt');
+            $tools[] = [
+                'name' => $toolName,
+                'description' => !empty($prompt) ? $prompt : $toolClass::getPrompt(),
+                'parameters' => $toolClass::getParameters(),
+            ];
+        }
+
+        return $tools;
     }
 
     public function getToolChoice(): string
diff --git a/core/components/modai/src/Services/CustomOpenAI.php b/core/components/modai/src/Services/CustomOpenAI.php
@@ -166,16 +166,14 @@ public function getCompletions(array $data, CompletionsConfig $config): AIRespon
         $input['messages'] = $messages;
 
         $tools = [];
-        foreach ($config->getTools() as $toolName => $tool) {
-            /** @var class-string<ToolInterface> $toolClass */
-            $toolClass = $tool->get('class');
+        foreach ($config->getTools() as $tool) {
 
             $tools[] = [
                 'type' => 'function',
                 'function' => [
-                    'name' => $toolName,
-                    'description' => $toolClass::getPrompt(),
-                    'parameters' => (object)$toolClass::getParameters(),
+                    'name' => $tool['name'],
+                    'description' => $tool['description'],
+                    'parameters' => (object)$tool['parameters'],
                 ]
             ];
         }
diff --git a/core/components/modai/src/Services/Google.php b/core/components/modai/src/Services/Google.php
@@ -212,17 +212,15 @@ public function getCompletions(array $data, CompletionsConfig $config): AIRespon
         }
 
         $tools = [];
-        foreach ($config->getTools() as $toolName => $tool) {
-            /** @var class-string<ToolInterface> $toolClass */
-            $toolClass = $tool->get('class');
-            $params = $toolClass::getParameters();
+        foreach ($config->getTools() as $tool) {
+            $params = $tool['parameters'];
             if (empty($params)) {
                 $params = null;
             }
 
             $tools[] = [
-                'name' => $toolName,
-                'description' => $toolClass::getPrompt(),
+                'name' => $tool['name'],
+                'description' => $tool['description'],
                 'parameters' => $params,
             ];
         }
diff --git a/core/components/modai/src/Services/OpenAI.php b/core/components/modai/src/Services/OpenAI.php
@@ -160,16 +160,13 @@ public function getCompletions(array $data, CompletionsConfig $config): AIRespon
         $input['messages'] = $messages;
 
         $tools = [];
-        foreach ($config->getTools() as $toolName => $tool) {
-            /** @var class-string<ToolInterface> $toolClass */
-            $toolClass = $tool->get('class');
-
+        foreach ($config->getTools() as $tool) {
             $tools[] = [
                 'type' => 'function',
                 'function' => [
-                    'name' => $toolName,
-                    'description' => $toolClass::getPrompt(),
-                    'parameters' => (object)$toolClass::getParameters(),
+                    'name' => $tool['name'],
+                    'description' => $tool['description'],
+                    'parameters' => (object)$tool['parameters'],
                 ]
             ];
         }
diff --git a/core/components/modai/src/Services/OpenRouter.php b/core/components/modai/src/Services/OpenRouter.php

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ public function process(array $scriptProperties = [])`
`22`	`22`
`23`	`23`	`$this->toolData = $tool->toArray();`
`24`	`24`	`$this->toolData['classConfig'] = $this->toolData['class']::getConfig($this->modx);`
	`25`	`+ $this->toolData['defaultPrompt'] = $this->toolData['class']::getPrompt();`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`public function getPageTitle()`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ public function process()`
`46`	`46`	`'config' => $class::getConfig($this->modx),`
`47`	`47`	`'suggestedName' => $class::getSuggestedName(),`
`48`	`48`	`'description' => $class::getDescription(),`
	`49`	`+ 'defaultPrompt' => $class::getPrompt(),`
`49`	`50`	`];`
`50`	`51`	`}, $classes), count($classes));`
`51`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public function beforeSet()`
`38`	`38`	`return false;`
`39`	`39`	`}`
`40`	`40`
`41`		`- $config = $class::getConfig();`
	`41`	`+ $config = $class::getConfig($this->modx);`
`42`	`42`	`$configValues = [];`
`43`	`43`	`foreach ($config as $key => $options) {`
`44`	`44`	`$configValues[$key] = $this->getProperty("config_$key");`