Search compendiums

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

Beyond the annotations' read-only and non-destructive hints, the description reveals exact-name-first ordering, word-wise matching, and the nuanced behavior of creature filters: real values with packType Actor, estimates from names otherwise, and unknown filters being reported as ignored. This is useful behavioral context beyond structured metadata.

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

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

The description is three dense sentences that front-load the core search behavior, then layer the important caveats about matching and filtering reliability. Every sentence adds functional information with no filler.

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

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

For a read-only search tool with a rich schema and no output schema, the description covers scope, matching semantics, ordering, filter reliability limitations, and the preferred alternatives for more precise or detailed lookups. It is complete enough for an agent to call it correctly.

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

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

The schema already has detailed parameter descriptions for all four parameters, so the baseline is high. The description adds extra meaning by adding exact-match ordering, scene-compendium exclusion, and clarifying the interplay between packType, filters, and adapter behavior, which nudges it above the baseline.

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

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

The description states a specific operation: searching compendium entry names across all compendiums except scene compendiums. It also clarifies the matching rule and ordering, so an agent can distinguish it from broader listing or individual lookup tools without opening the schema.

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

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

The description explicitly directs agents to list-creatures-by-criteria for accurate filtering and to get-compendium-item for inspecting single entries. It also states exclusions such as scene compendiums and the fact that descriptions are not searched, leaving little ambiguity about when this tool fits.

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