agorum_ai_agents_library_basic_directory_tree

Anzeigename: Retrieves the tree (file structure) of an agorum core directory from a starting folder.

Was macht das Tool?

Dieses Tool liefert die komplette Baumstruktur (Verzeichnisstruktur) eines agorum core Ordners ausgehend von einem festgelegten Startordner zurück. Der Rückgabewert ist ein verschachteltes JSON-Objekt, das alle Ordner (und optional auch Dateien) inklusive deren UUIDs und ausgewählten Metadaten bis zur gewünschten Tiefe aufführt.

Empfohlener Einsatzzweck

Das Tool eignet sich, um eine Übersicht über die Ordnerstruktur eines Bereichs in agorum core zu erhalten. Es kann genutzt werden, um Strukturen zu visualisieren, für automatisierte Auswertungen oder zur Navigation in komplexen Verzeichnisbäumen.

Funktionsbeschreibung

Parameter	Beschreibung
id (Pflicht)	ID (Pfad, UUID oder ID) des agorum core Objekts, von dem aus die Baumstruktur gelesen werden soll.
depth (Pflicht)	Tiefe des auszugebenden Baumes. Zahl zwischen 1 und 8. Gibt an, wie viele Ebenen der Baumstruktur abgerufen werden.
withFiles (Optional)	Gibt an, ob auch Dateien innerhalb der Ordner aufgelistet werden sollen. true: Dateien werden mit aufgelistet false: Nur Ordner werden aufgelistet Standard: false
metadataFields (Optional)	Optionale Metadatenfelder, die abgerufen werden sollen. Beschreibt, welche Metadatenfelder ausgelesen werden. Kann als Array von Feldnamen oder RegExp (in Schrägstrichen, z.B. /^ag_/) angegeben werden. '~': Alle nicht geerbten Metadatenfelder '~~': Alle geerbten Metadatenfelder ['~', '~~']: Alle Metadatenfelder (geerbt und nicht geerbt) ['identifier']: Nur das Feld 'identifier' []: Alle Metadatenfelder [' ']: Keine Metadatenfelder Standard: ['~', '~~']
basePathIds (Optional)	Basispfade zur Einschränkung. Der angegebene Startordner (id) muss sich unterhalb eines dieser Basispfade befinden. Falls der Startordner nicht unter einem der Basispfade liegt, wird eine Fehlermeldung zurückgegeben. Dies dient der Sicherheit und Zugriffskontrolle. Standard: ["/"]
limit (optional)	Maximale Anzahl von Objekten, die unterhalb des Ordners erlaubt sind. Wird diese Anzahl überschritten, gibt das Tool eine Fehlermeldung zurück und empfiehlt einen query-basierten Ansatz. Standard: 1000 Maximalwert: 5000

Tipps und Tricks

Tipps:

Um die Performance zu verbessern, sollte die depth möglichst klein gewählt werden. Bei sehr großen Verzeichnisbäumen empfiehlt es sich, gezielt mit basePathIds und metadataFields zu arbeiten, um die Datenmenge zu begrenzen.
Über die Option metadataFields können gezielt zusätzliche Informationen, wie zum Beispiel Bereichszuteilungen oder eindeutige Bezeichner, direkt für jeden Ordner/Datei im Baum mit ausgegeben werden – ideal für individuelle Berichte und Auswertungen. Die zurückgegebene Datenmenge kann dadurch allerdings auch sehr groß werden.
Die maximale depth beträgt 8. Bei größeren Strukturen ist ggf. eine gestaffelte Abfrage empfohlen.