Onboarding und Config Protocol: Ein Standard für alle Clients

Onboarding-Prozesse über verschiedene Plattformen hinweg synchron zu halten, ist oft mühsam. Wenn die CLI andere Parameter erwartet als die Web UI, führt das bei Entwicklern schnell zu Frust und Fehlkonfigurationen.

Die beste Lösung ist ein geteiltes Protokoll. Mit einer zentralen Wizard Engine stellst du sicher, dass die Logik überall identisch bleibt, egal ob deine User im Terminal oder in einer Desktop-App arbeiten. Das spart Zeit bei der Entwicklung und verhindert Inkonsistenzen in der User Experience.

Voraussetzungen

• Gateway RPC Endpunkte
• Zugriff auf das Wizard-System (Session + Prompts)

Schnellstart

In nur 5 Minuten setzt du den minimalen Pfad für das Onboarding und die Konfiguration auf.

1. Wizard Session starten Initialisiere den Prozess über wizard.start. Du kannst zwischen lokalem und remote Modus wählen.

   {
     "mode": "local",
     "workspace": "dein-workspace-pfad"
   }

2. Durch die Schritte navigieren Nutze wizard.next, um Antworten zu senden und den nächsten Schritt zu erhalten.

   {
     "sessionId": "session-id",
     "answer": {
       "stepId": "step-id",
       "value": "antwort-wert"
     }
   }

3. Status prüfen oder abbrechen Verwende wizard.status oder wizard.cancel mit deiner sessionId, um den aktuellen Fortschritt zu verwalten.

4. Config Schema abrufen Für die Darstellung von Formularen in der Web UI rufst du das Schema ab. Das Gateway liefert dir JSON Schema inklusive UI Hints.

   // Request an config.schema
   {}

   Die Response enthält wichtige Metadaten:

   {
     "schema": {},
     "uiHints": {},
     "version": "1.0.0",
     "generatedAt": "timestamp"
   }

Fehlerbehebung

• Ein Schema-Knoten wird in der UI nicht gerendert Wenn ein Knoten im JSON Schema nicht unterstützt wird, nutzt das System automatisch den raw JSON Editor als Fallback.
• Sensible Daten werden im Klartext angezeigt Stelle sicher, dass das Feld in den uiHints als sensitiv markiert ist. Diese Felder werden als Password Inputs gerendert. Beachte jedoch, dass es aktuell keinen Redaction Layer gibt.

Du hast Fragen zum Setup? Nutze den AI Setup Assistant.

Nächste Schritte

• Gateway RPC Referenz
• UI Hints Dokumentation
• Wizard Step Model Details
• JSON Schema Integration Guide