zum Hauptinhalt springen
Dokumentation durchsuchen

Der Fähigkeitskatalog

Die strukturierte Liste dessen, was Ihre API kann – einmal erkannt, von Ihnen verfasst und von jeder Oberfläche gelesen.

Der Fähigkeitskatalog ist das Herz von Syncanix. Er ist eine strukturierte Beschreibung all dessen, was Ihr Produkt kann, aus Ihrer API erkannt und von Ihnen verfeinert. Jede Oberfläche – das Widget, der Chat, der MCP-Server – liest aus diesem einen Katalog, sodass die Fähigkeiten Ihres Assistenten überall konsistent sind und an einer einzigen Stelle bearbeitet werden.

Was eine Fähigkeit ist

Eine Fähigkeit ist eine einzelne Sache, die Ihre API kann: ein einzelner Endpunkt oder eine Aktion, etwa „eine Bestellung nachschlagen“ oder „eine Zahlung erstatten“. Jede ist gut genug beschrieben, damit der Assistent versteht, was sie tut, was sie braucht und wann er sie nutzen soll.

Was jede Fähigkeit enthält

Bezeichner
Eine stabile id in der Form domain.action (zum Beispiel orders.refund), überall verwendet, wo die Fähigkeit referenziert wird.
Methode & Pfad
Die HTTP-Methode und der Pfad, auf die die Fähigkeit abbildet (zum Beispiel POST /orders/{id}/refund).
Eingaben
Die Argumente, die die Aktion annimmt, mit ihren Namen und Typen – nie Beispielwerte aus Ihren Daten.
Beschreibung
Eine Zusammenfassung in klarer Sprache, was die Aktion tut. Sie ist es, die der Assistent liest, um zu entscheiden, ob und wann er sie nutzt.
Nebenwirkung
Ob die Aktion liest, schreibt oder destruktiv ist – was steuert, wie sie vor der Ausführung bestätigt wird.
Risiko
Eine Risikostufe, mit der Sie manche Aktionen vorsichtiger behandeln können, als ihre Nebenwirkung allein nahelegen würde.
Erforderliche Berechtigungen
Die Berechtigungen (Scopes), die ein Nutzer haben muss, damit ihm die Aktion überhaupt angeboten wird.
Intern-Kennzeichnung
Kennzeichnet eine Fähigkeit als intern, sodass sie außerhalb der Reichweite des Assistenten bleibt, aber in Ihrem Katalog verbleibt.
Kennzeichnung personenbezogener Daten
Kennzeichnet Eingaben oder Ausgaben mit personenbezogenen Daten, damit sie angemessen behandelt und maskiert werden.

Erkannt, dann verfasst

Die Erkennung schlägt den Katalog vor, indem sie Ihren Code statisch liest. Von dort an verfassen Sie ihn: Fähigkeiten umbenennen, Beschreibungen schärfen, Nebenwirkungen und Risiko festlegen, Endpunkte als intern markieren und erforderliche Berechtigungen anpassen – alles im Dashboard. Ihre Änderungen werden als Überschreibungen gespeichert und überstehen so den nächsten Erkennungslauf.

Eine Quelle der Wahrheit

Weil Widget, Chat-Oberfläche und MCP-Server alle aus demselben Katalog lesen, legen Sie einmal fest, was der Assistent kann. Ändern Sie eine Fähigkeit im Dashboard, und jede Oberfläche spiegelt es wider.

Nächste Schritte