agorum_ai_agents_library_basic_documentation_document

Anzeigename: Gets an agorum core dokumentation document

Was macht das Tool?

Dieses Tool liest ein einzelnes Dokument aus der agorum core Dokumentation aus und gibt dessen Inhalt als Markdown zurück. Die Identifikation des Dokuments erfolgt über die UUID. Um eine UUID zu erhalten, kann das Tool agorum_core_documentation_tree verwendet werden, das eine Liste aller verfügbaren Dokumente liefert. Das Ergebnis enthält den eigentlichen Dokumenteninhalt sowie einen Link auf das Dokument.

Empfohlener Einsatzzweck

Das Tool eignet sich ideal, um gezielt einzelne Dokumentationsseiten aus dem agorum core System automatisiert auszulesen, z. B. für die Anzeige in eigenen Oberflächen, für die Weiterverarbeitung in anderen Systemen oder für die automatisierte Dokumentationsauswertung.

Funktionsbeschreibung

Parameter	Beschreibung
uuid (Pflicht)	UUID des Dokumentationsdokuments, das ausgelesen werden soll.
docUrl (optional, vorkonfiguriert)	URL des Dokumentationssystems (z. B. https://agorumdocproxy.agorum.com). Wird in der Regel zentral konfiguriert und muss nicht angegeben werden.
docId (optional, vorkonfiguriert)	Basis-UUID der Dokumentation. Wird normalerweise zentral vorgegeben.
docLanguage (optional, vorkonfiguriert)	Sprache der Dokumentation (z. B. de-DE). Standard ist die zentrale Konfiguration.
docPath (optional, vorkonfiguriert)	Pfad zur Dokumentation (z. B. /roiwebui/acds_module/overview2/index.html#/). Wird meist zentral vorgegeben.
docToken (optional, vorkonfiguriert)	JWT-Token für die Authentifizierung. Wird in der Regel automatisch gesetzt.

Beispiel-Prompt

Ermittle das Markdown eines spezifischen Dokumentationsdokuments:

Tool: agorum_ai_agents_library_basic_documentation_document
Parameter:
  uuid: [hier die UUID des gewünschten Dokuments eintragen]

Tipps und Tricks