« Zurück zu Produkt

Dokumentation

Feedback senden!

KI-Agenten

Die komplette Dokumentation steht zusätzlich als Markdown zur Verfügung, das für KI-Agenten und Large Language Models (LLMs) optimiert ist, z.B. für Claude, ChatGPT, Cursor oder GitHub Copilot. Die Dateien werden bei jeder Aktualisierung der Webseite automatisch neu erzeugt und sind somit immer auf dem Stand dieser Dokumentation.

Im Gegensatz zur HTML-Seite oder dem PDF enthalten die Dateien nur den Inhalt ohne Layout. Dadurch benötigen sie deutlich weniger Tokens und können von KI-Agenten schneller verarbeitet werden.

Aufbau

Die Dateien folgen dem llms.txt Standard:

Datei Beschreibung
llms.txt Index aller Dateien mit Kurzbeschreibung und ungefährer Größe in Tokens. Der Einstiegspunkt für KI-Agenten.
llms/function-index.md Alle Funktionen der Befehlsreferenz und des SDK mit Signatur und Kurzbeschreibung, jeweils mit einem Link auf die Datei mit Parametern und Beispielen.
llms/function-index-modules.md Alle modulspezifischen Funktionen (z.B. ENO*, KNX*) mit Signatur und Kurzbeschreibung, jeweils mit einem Link auf die Moduldatei.
llms/modules/*.md Eine Datei pro Modul, z.B. enocean.md oder knx.md, inklusive der Modulfunktionen.
llms/functions/*.md Die Befehlsreferenz, eine Datei pro Gruppe, z.B. management-variables.md.
llms-full.txt Die komplette Dokumentation in einer Datei, z.B. zum Hochladen in eine Wissensdatenbank.

Keine Datei ist größer als ca. 80.000 Zeichen, damit KI-Agenten jede Datei vollständig abrufen können. Größere Bereiche werden auf mehrere Dateien aufgeteilt, z.B. eine Datei pro Formularelement der Konfigurationsformulare. Jede Datei mit mehreren Seiten beginnt mit einem Inhaltsverzeichnis, das auch auf die ausgelagerten Unterseiten verweist.

Die Dateinamen sind in allen Sprachen identisch. Die englische Version steht unter /en/llms.txt zur Verfügung.

Verwendung

Die meisten KI-Agenten können die Dateien direkt abrufen. Es genügt, dem Agenten die Adresse des Index mitzuteilen, z.B. in der Datei CLAUDE.md oder AGENTS.md des eigenen Modul-Projekts:

Die Symcon Dokumentation für KI-Agenten ist unter https://www.symcon.de/de/llms.txt verfügbar.
Für PHP-Funktionen zuerst https://www.symcon.de/de/llms/function-index.md (Befehlsreferenz und SDK) bzw. https://www.symcon.de/de/llms/function-index-modules.md (Modulfunktionen) laden.

Alternativ kann die Datei llms-full.txt als Wissensdatenbank in einem Projekt (z.B. Claude Projects oder NotebookLM) hochgeladen werden.

MCP-Server

Neben der Dokumentation gibt es einen MCP-Server für den persönlichen Bereich. Über ihn können KI-Assistenten Lizenzen verwalten, Module im Module Store veröffentlichen und Tester einladen: MCP-Server

Dateien

Haben Sie noch Fragen?