AI Agent Docs
Wenn Sie einen AI Assistant zum Einrichten oder Troubleshooting von Integration CLI verwenden, geben Sie ihm zuerst die veröffentlichte AI-Dokumentations-URL. Die URL hält den Assistant auf die neueste CLI-Dokumentation ausgerichtet statt auf eine ältere heruntergeladene Kopie.
Verwenden Sie sie, wenn ein Assistant helfen soll bei:
- Erstellen einer
mapping.yml-Datei. - Auswählen von
optimus check-Optionen. - Erklären von Ergebnis-CSV-Spalten.
- Troubleshooting von Authentifizierung, CSV-Parsing, Folder Mode oder Exit Codes.
- Verstehen von Support-Logs und gespeichertem Validierungszustand.
Sie benötigen diese Dateien nicht, um Integration CLI auszuführen. Sie dienen nur dazu, einem AI Assistant besseren Kontext zu geben.
Verfügbare Dateien
| Datei | Verwendung |
|---|---|
/llms.txt | Bester Standard für Agents, die URLs öffnen können. Sie sagt dem Assistant, welche CLI-Dokumente in welcher Reihenfolge gelesen werden sollen. |
/llms-full.txt | Bester Fallback, wenn der Assistant nicht mehrere Dokumentationsseiten browsen kann oder eine vollständige CLI-Referenz in einer Datei braucht. Teilen Sie nach Möglichkeit die URL; laden Sie sie nur für Offline- oder Fixed-Version-Arbeit herunter. |
Bedeutung
- Verwenden Sie diese Dateien, wenn Sie Hilfe mit der CLI wollen: Installation, CSV-Mappings konfigurieren,
optimus checkausführen, Ergebnis-CSVs lesen, Folder Mode nutzen oder einen fehlgeschlagenen Lauf debuggen. - Erwarten Sie in diesen Dateien keine API-Endpunktschemas, Request Bodies oder Response Models.
- Wenn Sie eine direkte HTTP-Integration bauen statt die CLI zu verwenden, nutzen Sie die Integration-API-Dokumentation.
- Teilen Sie lieber die veröffentlichte URL als eine heruntergeladene Kopie hochzuladen. Heruntergeladene Dateien können veralten.
- Die veröffentlichten Dateien werden bei jedem Build der Dokumentationsseite aus der CLI-Dokumentation neu gebaut und bleiben dadurch mit den veröffentlichten CLI-Dokumenten synchron.
Sie müssen nicht zwischen CLI-Dokumentation und AI-Dateien wählen. Die AI-Dateien sind nur eine maschinenlesbare Kopie der CLI-Dokumentation für Assistants.
Empfohlener Agent Prompt
Wenn Sie einem Agent eine URL geben, fügen Sie eine kurze Anweisung hinzu, zum Beispiel:
Use this Integration CLI documentation URL to help configure and troubleshoot optimus check: <llms-url>
Do not invent CLI options, YAML keys, output columns, or status values that are not present in the documentation.
Do not include real tok_optimus_ token values in examples.
Sicherheitshinweise
Fügen Sie keine echten Personal Access Tokens, Kunden-CSV-Daten, USt-IdNrn. aus privaten Daten, Support-Logs oder Ergebnisdateien in öffentliche AI-Tools ein.
Verwenden Sie Platzhalter wie:
<token>
customers.csv
mapping.yml