Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core Module und Plugins > ALBERT | AI Suite > ALBERT| AI KI-Tools-Dokumentationen


configurator_run – Vorgang des Konfigurators ausführen (ALBERT | AI Tool)

Hinweise: 

  • Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins ALBERT | AI Dev (Bestandteil der ALBERT | AI Suite). Aktualisieren Sie das hier beschriebene Plugin, um die Dokumentation verwenden zu können.
  • Wie Sie die KI-Tools in Ihren KI-Voreinstellungen verwenden, erfahren Sie hier: ALBERT | AI agents tools einrichten

Anzeigename: Configurator: run an operation

Interner Name: agorum_ai_dev_configurator_run (über MCP: configurator_run)

Was macht das Tool?

Das Tool führt einen Vorgang einer Config des Konfigurators von agorum.dev in einem Konfigurationsprojekt aus. Es schreibt dabei alles, was zu dem Vorgang gehört:

Es gelten genau dieselben Regeln wie im Konfigurator: Der Konfigurator berechnet etwa Projekt und Registrierungsnamen aus dem Pfad des Skripts und baut nach der Registrierung eines Widgets den aguila-Cache neu auf.

Achtung: Das Tool schreibt sofort, sobald es ohne dryRun aufgerufen wird. Lassen Sie die KI, wo die Config es anbietet, zuerst einen Probelauf mit dryRun: true machen.

Empfohlener Einsatzzweck

Verwenden Sie das Tool für alles, was der Konfigurator abdeckt - statt MetaDB-Einträge, export.yml-Zeilen oder Deploy-Skripte von Hand zu schreiben. Von Hand fehlt fast immer einer der Schritte, die der Konfigurator automatisch erledigt. Typische Aufgaben:

Rufen Sie vorher configurator_describe auf: Das Tool nennt die Vorgänge einer Config und ihre Parameter. Für den Einsatz im Chat ist das Tool nicht vorgesehen. Es steht im Developer Studio und über MCP für externe Coding Agents zur Verfügung, siehe die Toolgruppe agorum_ai_dev_configurator_tools.

Funktionsbeschreibung

Parameter Beschreibung
configId
(Pflicht)
Kennung der Config, wie configurator_list sie liefert, zum Beispiel aguila-widget.
operation
(Pflicht)
Der auszuführende Vorgang. Mögliche Werte:
  • register: ein Skript registrieren (Kategorie type)
  • unregister: eine Registrierung abmelden (Kategorie type)
  • execute: etwas für ein Projekt ausführen (Kategorie executor)
  • action: eine benannte Aktion ausführen (Kategorie manager)
  • createFromTemplate: eine neue Datei aus einer Vorlage anlegen
action
(optional)
Nur bei operation: action: der Name der Aktion, zum Beispiel create.
templateId
(optional)
Nur bei operation: createFromTemplate: die Kennung der Vorlage, wie configurator_describe sie nennt.
options
(optional)
Die Parameter des Vorgangs, mit genau den Namen, die configurator_describe nennt. Eine unbekannte Option wird abgelehnt. Beispiele:
  • register: { "scriptPath": "/agorum/roi/customers/<Projekt>/js/aguila/my-widget.js" } - Projekt und Registrierungsname ergeben sich aus dem Skript
  • unregister: { "project": "...", "name": "..." }, wie configurator_entries sie liefert
  • execute: zum Beispiel { "project": "agorum.demo" } oder der Pfad einer YML-Datei als project
  • createFromTemplate: { "project": "...", "values": { <Platzhalter>: "..." }, "register": true } - die Platzhalterschlüssel exakt wie in configurator_describe
dryRun
(optional)
Nur planen, nichts schreiben. Möglich, wo configurator_describe beim Vorgang dryRun: true nennt.
  • true: Das Tool liefert nur den Plan, bei createFromTemplate etwa Pfad, Inhalt, Texte und Deploy-Skript der neuen Datei, bei register Projekt, Name und die Probleme, die die Regeln finden.
  • false: Der Vorgang wird sofort ausgeführt.
Standard: false
allowedBasePathIds
(optional, nur in der Tool-Konfiguration)
Basispfade, unterhalb derer das Tool schreiben darf. Der Wert wird nicht von der KI gesetzt, sondern in der Tool-Konfiguration. Geprüft werden das Projekt des Vorgangs und jeder Wert eines Projekt-, Skript- oder Objektfelds. Liegt ein Ziel außerhalb oder wird es nicht gefunden, lehnt das Tool den Vorgang mit einer Fehlermeldung ab.

Achtung: Bei operation: action wird der Ordner /agorum/roi/customers selbst geprüft. Ist das Tool auf einzelne Projekte eingeschränkt, lehnt es deshalb alle Aktionen ab, etwa ein Projekt anlegen, klonen oder exportieren.

Standard: ["/"]

Rückgabe

{
  "configId": "aguila-widget", "operation": "register",
  "result": { "name": "agorum.demo.myWidget", "metadbPath": "...", "exportYmlUpdated": true },
  "postActions": [{ "name": "afterRegister", "done": true }]
}

Mit dryRun: true lautet die Rückgabe:

{ "configId": "...", "operation": "...", "dryRun": true, "plan": { ... } }

Was das Tool nicht ausführt

Beispiel-Prompt

Lege im Projekt my.project mit den Konfigurator-Tools ein neues aguila-Widget
"customer-overview" aus der passenden Vorlage an und registriere es.
Mache zuerst einen Probelauf und zeige mir den Plan, bevor du schreibst.

Ein Aufruf, wie ihn die KI daraus erzeugt, könnte so aussehen (Platzhalterschlüssel und Vorlage aus configurator_describe):

{
  "configId": "aguila-widget",
  "operation": "createFromTemplate",
  "templateId": "<Vorlage aus configurator_describe>",
  "options": {
    "project": "my.project",
    "values": { "<Platzhalterschlüssel>": "customer-overview" },
    "register": true
  },
  "dryRun": true
}

Tipps und Tricks

Tipp: Halten Sie die KI zur Reihenfolge list – describe – entries – run an und lassen Sie sie Projekt und Registrierungsnamen nie selbst erfinden: Sie folgen aus dem Skriptpfad. Schränken Sie mit allowedBasePathIds in der Tool-Konfiguration ein, in welchen Projekten das Tool schreiben darf - beachten Sie dabei, dass Projektaktionen dann nicht mehr möglich sind. Nicht über den Konfigurator laufen unter anderem KI-Tools (.ac_ai_td), AI-Handler, die Knoten eines Workflows und die Inhalte eines Smart-Assistant-AddOns.