configurator_describe – Baustein des Konfigurators beschreiben (ALBERT | AI Tool)

Anzeigename: Configurator: describe a config

Interner Name: agorum_ai_dev_configurator_describe (über MCP: configurator_describe)

Was macht das Tool?

Das Tool beschreibt eine einzelne Config des Konfigurators von agorum.dev: wozu sie dient, welche Parameter jeder ihrer Vorgänge erwartet, welche Regeln gelten, welche Dateivorlagen sie mitbringt und mit welchen Code-Beispielen sie arbeitet. Die Kennung der Config ermitteln Sie vorher mit configurator_list.

Die Parameter stammen aus demselben Formular, das der Konfigurator einem Benutzer zeigt. Die KI erhält damit genau die Angaben, die sie für configurator_run braucht.

Das Tool liest nur und verändert nichts im System.

Empfohlener Einsatzzweck

Verwenden Sie das Tool zwischen configurator_list und configurator_run: Die KI erfährt, welche Optionen ein Vorgang annimmt, welche davon Pflicht sind und ob ein Probelauf (dryRun) möglich ist. configurator_run lehnt jede Option ab, die hier nicht genannt ist.

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.
action (optional)	Nur bei einer Config mit benannten Aktionen, etwa der Kategorie manager: Beschreibt nur diese eine Aktion, zum Beispiel create. Ein unbekannter Aktionsname führt zu einer Fehlermeldung.

Rückgabe

{
  "id": "aguila-widget", "category": "type", "summary": "...", "description": "...",
  "sourceProject": "agorum.dev",
  "rules": { "requiredPath": "/js/aguila/", "metadbPath": "...", "stopFolder": "..." },
  "operations": {
    "register": { "parameters": [{ "name": "scriptPath", "type": "string", "required": true }], "dryRun": true,
      "postActions": ["afterRegister"] },
    "unregister": { "parameters": [{ "name": "project" }, { "name": "name" }], "dryRun": false },
    "createFromTemplate": { "parameters": [...], "dryRun": true }
  },
  "templates": [{ "id": "basic-widget", "fileName": "...", "targetPath": "/js/aguila/",
    "placeholders": [{ "key": "...", "default": "my-widget", "pattern": "..." }], "available": true }],
  "examples": [{ "title": "...", "code": "..." }]
}

Bietet eine Config benannte Aktionen an, etwa eine Config der Kategorie manager, steht unter operations zusätzlich die Angabe actions mit den Aktionen, ihrer Beschriftung, der Angabe aiAllowed und ihren Parametern.

Die Angaben zu einem Parameter

Angabe	Bedeutung
name	Der Schlüssel in options von configurator_run.
type	Art des Werts, der zu übergeben ist, zum Beispiel string, boolean, number, array oder object (etwa values bei createFromTemplate).
required, default, options, pattern	Pflichtangabe, Vorgabewert, erlaubte Werte mit ihrer Beschriftung sowie ein regulärer Ausdruck, dem der Wert entsprechen muss.
calculated	true: Der Wert ergibt sich aus einem anderen Wert. Projekt und Name einer Registrierung folgen etwa aus dem Pfad des Skripts. Übergeben Sie ihn höchstens zur Kontrolle; ein abweichender Wert wird abgelehnt.
conditional	true: Das Formular zeigt das Feld nur bei bestimmten Werten anderer Felder.
aiAllowed	false: Das Feld ist den KI-Tools entzogen. Lassen Sie es leer und überlassen Sie es dem Benutzer.

Die Angaben zu Regeln und Vorlagen

• rules.requiredPath: der Ordner unterhalb des Projekts, in dem ein Skript liegen muss, zum Beispiel /js/aguila/.
• templates: die Dateivorlagen der Config. Der Schlüssel (key) jedes Platzhalters - ein Dollarzeichen und der Name in geschweiften Klammern, etwa ${name} - ist exakt so in options.values von createFromTemplate anzugeben, wie er hier steht. Projekt und Registrierungsname füllt agorum.dev selbst aus.
• default eines Platzhalters ist der Wert, den das Formular einträgt. example zeigt dagegen nur die Form eines Werts und ist nicht zum Einsetzen gedacht.
• messages einer Vorlage nennt die Schlüssel der Texte, die die Vorlage in die Sprachdateien des Projekts einträgt, deployScript das Skript, das sie in deploy/pre/js anlegt.

Beispiel-Prompt

Beschreibe mit configurator_describe die Config aguila-widget.
Welche Vorlagen gibt es, welche Platzhalter haben sie,
und kann ich die Registrierung vorher als Probelauf prüfen?

Tipps und Tricks