Skip to main content
Glama

List documents of any type

list-documents
Read-onlyIdempotent

List 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

TableJSON Schema
NameRequiredDescriptionDefault
packNoCompendium id "package.name" to read from; compendiums are read only here
limitNoDocuments per answer, 1 to 200; default 25
whereNoConditions that must all hold
fieldsNoDotted paths to return, list positions as ".0" or "[0]" and "*" for every entry, e.g. "system.attributes.hp.value", "items.*.name". ["*"] returns all data
offsetNoSkip this many matching documents; nextOffset of the previous answer
sortByNoField path to sort by; default is Foundry's order
maxCharsNoCharacter budget of the answer, 1000 to 200000; default 60000
parentUuidNouuid of the document that holds an embedded one, e.g. "Actor.abc" for its items, "Scene.abc" for its walls
documentTypeYesFoundry document name, e.g. "Actor", "JournalEntryPage", "Combat", "Wall"; with id when no uuid is given
sortDirectionNoSort direction; default asc

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv14.2609.4

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already mark this as read-only and idempotent with no destructive actions, so the safety profile is clear. The description adds behavioral context about compendium read-only limitation and default row selection when 'fields' is omitted, which is useful beyond the schema. No contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact relative to the complexity of a 10-parameter tool. It front-loads the core purpose and the fallback role, then lists the specialized alternatives. Every sentence adds value, and the parameter-level behavior is covered in the schema, keeping the description efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a generic tool with a rich schema (10 params, 100% coverage) and no output schema, the description provides sufficient context: it explains the fallback role, points to alternatives, and gives default behavior. However, it could mention pagination or sorting defaults more explicitly, but the schema covers those. Given the complexity, this is nearly complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3 per the rubric. The description adds a few behavioral clarifications (e.g., 'Without fields each row shows id, uuid, name, type and folder' and 'compendiums are read only here'), but most parameters are already well-documented in the schema. The description doesn't significantly augment parameter semantics beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a clear action ('list documents of any type') and specifies the resource (world, parentUuid, compendium). It immediately establishes itself as the generic fallback and distinguishes itself from a long list of specialized siblings, which prevents ambiguity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly tells the agent when to use this tool: 'Prefer the specialised tools where one fits' and lists them. It also names concrete use cases for this tool (Combat, Cards, Wall, etc.) and notes when to use it for game systems without an adapter. This is excellent routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools