List documents of any type
list-documentsList Foundry VTT documents of any type with conditions, sorting, pagination, and field selection. Use for types not covered by specialized tools.
Instructions
Generic fallback: list documents of any type in the world, inside one document (parentUuid) or in a compendium (pack, read only), with conditions, sorting, paging and field selection. Prefer the specialised tools where one fits: list-journals, list-scenes, list-characters, list-compendium-entries, list-chat-messages, list-macros, list-playlists, list-roll-tables. Use this for types they do not cover (Combat, Cards, Wall, Region, Drawing), for game systems without an adapter, or to get exactly the fields needed. Without fields each row shows id, uuid, name, type and folder. describe-document-type shows the field paths.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pack | No | Compendium id "package.name" to read from; compendiums are read only here | |
| limit | No | Documents per answer, 1 to 200; default 25 | |
| where | No | Conditions that must all hold | |
| fields | No | Dotted paths to return, list positions as ".0" or "[0]" and "*" for every entry, e.g. "system.attributes.hp.value", "items.*.name". ["*"] returns all data | |
| offset | No | Skip this many matching documents; nextOffset of the previous answer | |
| sortBy | No | Field path to sort by; default is Foundry's order | |
| maxChars | No | Character budget of the answer, 1000 to 200000; default 60000 | |
| parentUuid | No | uuid of the document that holds an embedded one, e.g. "Actor.abc" for its items, "Scene.abc" for its walls | |
| documentType | Yes | Foundry document name, e.g. "Actor", "JournalEntryPage", "Combat", "Wall"; with id when no uuid is given | |
| sortDirection | No | Sort direction; default asc |