zum Hauptinhalt springen
Dokumentation durchsuchen

Schnellstart

Von einem Script-Tag zu einem funktionierenden Assistenten in Ihrer App – und Sie entscheiden, was er anfassen darf.

Diese Anleitung führt Sie von einer bestehenden Anwendung zu einem laufenden Syncanix-Assistenten, in der Reihenfolge, in der man es wirklich tut: Snippet einfügen, Website erfassen, dann die Anleitungen veröffentlichen, die daraus entworfen werden. Prüfung und Livegang rahmen das ein. Zwei Schritte sind optional und als solche gekennzeichnet — ein tieferer Scan Ihres Codes und die direkte Anbindung Ihres Backends.

Bevor Sie beginnen

  • Ein Syncanix-Arbeitsbereich — kontaktieren Sie unser Vertriebsteam unter syncanix.com/contact.
  • Node.js 20 oder neuer.
  • Eine bestehende HTTP-API mit mindestens einem authentifizierten Endpunkt.
  • Ein Identitätsanbieter für Ihre Nutzer – Auth0, Clerk, Cognito, WorkOS oder Ihr eigener OIDC.
  • Ein Anthropic-, OpenAI- oder AWS-Bedrock-EU-Schlüssel — oder nutzen Sie den verwalteten Modellzugang, der in Ihrem Plan enthalten ist.

1. Arbeitsbereich und Schlüssel einrichten

Die Discovery-CLI lädt in einen Syncanix-Arbeitsbereich hoch, und das Widget authentifiziert sich mit einem veröffentlichbaren Schlüssel — legen Sie also den Arbeitsbereich an und holen Sie sich beide Schlüssel, bevor Sie irgendetwas ausführen.

  1. Ihren Arbeitsbereich erhaltenKontaktieren Sie unser Vertriebsteam unter syncanix.com/contact, um Ihren Arbeitsbereich einzurichten. Im Dashboard liegen Ihr Katalog, Ihre API-Schlüssel und Ihre Widget-Konfiguration.
  2. Über die CLI anmeldenFühren Sie npx syncanix login aus: Ihr Browser öffnet das Dashboard zur Bestätigung dieses Geräts, und die CLI speichert eine mit Ihrem Konto verknüpfte Sitzung in ~/.syncanix/credentials, damit init Ihren Katalog hochladen kann. Headless-Maschine? Führen Sie npx syncanix login --key aus und fügen Sie einen Maschinenschlüssel aus Einstellungen → API-Schlüssel ein.
  3. Ihren veröffentlichbaren Schlüssel kopierenKopieren Sie unter Einstellungen → API-Schlüssel im Dashboard Ihren veröffentlichbaren Schlüssel (pk_live_…). Das Widget-Einbettungs-Snippet verwendet ihn als data-key — er kann gefahrlos im Browser ausgeliefert werden.
npx syncanix login

2. Widget einbetten

Fügen Sie Ihrer App ein Script-Tag mit Ihrem Publishable Key hinzu. Das ist die gesamte Installation — kein Paket, kein Codeeingriff.

<script
  type="module"
  src="https://cdn.syncanix.com/widget.js"
  data-key="pk_live_..."
></script>

Das war’s. Das Widget lädt verzögert, läuft in einem Shadow DOM, damit Ihre und unsere Styles nie kollidieren, übernimmt Ihre Marke automatisch und ist bereit für Rechts-nach-links.

3. Lassen Sie es Ihr Produkt lesen

Mit dem Widget auf der Seite findet der Agent heraus, was Ihr Produkt kann, indem er hinsieht. Das geschieht auf zwei Wegen, und Sie müssen sich nicht entscheiden: Der erste ist bewusst und schnell, der zweite läuft danach leise weiter.

  1. Ein geführter Rundgang, in einem DurchgangStarten Sie einen Rundgang im Dashboard und klicken Sie sich in Ihrem eigenen Browser durch Ihr Produkt, angemeldet als Sie selbst. Es notiert dabei jeden Screen. Es wird von nirgendwo anders gesendet als aus dem Tab, in dem Sie sind.
  2. Danach fortlaufend, während sich Ihre Nutzer bewegenEinmal live, liest es weiterhin die Screens, die Menschen tatsächlich besuchen — eine Seite, die Sie am Dienstag ausliefern, ist am Dienstag bekannt. Niemand schreibt ein Ticket, um es ihm beizubringen.

4. Prüfen Sie, was es gefunden hat

Öffnen Sie das Dashboard, um zu sehen, was erkannt wurde. Hier entscheiden Sie, was der Assistent tun darf – und wie vorsichtig:

  • Markieren Sie interne Endpunkte, damit sie außerhalb der Reichweite des Assistenten bleiben.
  • Legen Sie die Nebenwirkung jeder Aktion fest – lesend, schreibend oder destruktiv –, was steuert, wie sie bestätigt wird.
  • Verlangen Sie für sensible Aktionen eine erhöhte Authentifizierung, damit der Nutzer seine Identität erneut bestätigt, bevor sie ausgeführt werden.

5. Optional: Ihren Quellcode für die genauen Formen lesen

Einen Bildschirm zu lesen sagt dem Agenten, was eine Person dort tun kann. Ihren Quellcode zu lesen sagt ihm genau, was Ihre Software akzeptiert — Parameternamen, Typen, was erforderlich ist — und findet Fähigkeiten, die noch niemand besucht hat. Das ist der tiefere Weg, nicht der schwerere: keine Quelldatei verlässt Ihren Rechner. Führen Sie es in Ihrem Repository aus:

npx syncanix init

6. Optional: Backend anbinden

Wenn Sie es hinzufügen, installieren Sie das SDK in dem Dienst, dem Ihre API gehört. Es startet in wenigen Millisekunden und hält Ihren Katalog per Laufzeit-Drift-Erkennung aktuell:

npm install @syncanix/sdk-node
import { init } from '@syncanix/sdk-node';

// Resolves your API key from SYNCANIX_API_KEY, ~/.syncanix/credentials,
// or an inline { apiKey } — in that order.
const { environment, bootDurationMs } = await init({ environment: 'development' });
console.log(`Syncanix booted in ${bootDurationMs.toFixed(1)}ms`);

Sie können auch SDK-eigene Werkzeuge registrieren – Aktionen, die der Assistent aufrufen kann und die keine einfachen HTTP-Routen sind. Jede läuft mit der Identität des Endnutzers, die Ihr Identitätsanbieter liefert:

import { createToolRegistry } from '@syncanix/sdk-node';

const registry = createToolRegistry();

registry.tool({
  name: 'refund-order',
  description: 'Refund a customer order. Requires an admin role.',
  handler: async ({ orderId, amountCents }, ctx) => {
    // ctx.userId is the verified end user from your identity provider.
    return payments.refund({ orderId, amountCents, actor: ctx.userId });
  },
});

7. KI-Client verbinden

Jeder Workspace erhält außerdem seinen eigenen MCP-Server, sodass Ihre Nutzer dieselben Fähigkeiten aus Claude Desktop, Cursor und ChatGPT erreichen. Die Anmeldung wird an Ihren Identitätsanbieter föderiert.

8. Live gehen

Wenn Sie mit dem Verhalten des Assistenten in der Entwicklung zufrieden sind, überführen Sie ihn im Dashboard in die Produktion. Zuvor läuft eine Bewertungsstufe, die die Überführung blockiert, wenn die Qualität nachlässt – so verändert sich die Produktion nur zum Besseren.

Was Sie jetzt haben

  • Einen eingebetteten Assistenten in Ihrer App, der Fragen beantwortet und Ihre Aktionen ausführt.
  • Ein MCP-Server pro Workspace für Claude Desktop, Cursor und ChatGPT.
  • Ein Prüfprotokoll jeder Aktion, jeder Überführung und jeder Administrationsänderung.
  • Alles in der EU gehostet, mit Ihren Daten verschlüsselt im Ruhezustand.

Nächste Schritte