get_document_model

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

No annotations are provided, so the description carries the transparency burden. It discloses caching behavior, the conditions for triggering a rescan (forceRefresh or cache empty), and implies a potentially expensive rescan. It doesn't cover error conditions or return shape, but for a read-like summary tool the key behaviors are addressed.

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?

A single sentence that front-loads the primary action, then adds the key conditional behavior. Every word earns its place with no redundancy or 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 tool with four optional parameters, no output schema, and no annotations, the description provides the essential use-case context: cached summary retrieval with rescan conditions. It doesn't detail the return value, but the name and purpose make that predictable. The combination of schema descriptions and this concise overview is sufficient for correct invocation.

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?

Schema coverage is 75%, so baseline is 3. The description adds meaning to forceRefresh and cache-related parameters (maxAgeMs, cache empty), and the phrase 'without rescanning' clarifies the tool's core mechanism. It doesn't explicitly mention timeoutSec or includeItems, but these are already documented well in the schema.

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 uses a specific verb ('Return a summary') and names the resource ('cached Document Model'), clearly distinguishing it from sibling tools like scan_document or refresh_document. The phrase 'without rescanning InDesign' further sharpens its identity as a cache-reading operation.

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?

It implicitly provides usage context: use when you want a summary without rescanning, unless the cache is empty or forceRefresh is set. It doesn't explicitly name alternatives or state when to avoid, but the 'without rescanning' phrasing contrasts with scan_document, offering usable guidance.

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