Get Document State

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

The description discloses it is a one-shot reader (non-destructive) and enumerates the key fields returned. Since no annotations are provided, the description adequately covers behavioral traits for a simple read operation.

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 exceptionally concise with two sentences. The first sentence immediately states the tool's purpose and outputs, and the second pairs it with its writer counterpart, all without unnecessary words.

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?

Given the tool has no parameters, no annotations, and no output schema, the description fully covers its purpose and return values. It also provides a natural pairing with set_document, making it self-contained for a simple getter.

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?

There are no parameters, so the baseline is 4. The description does not need to add parameter information beyond the schema, which already has 100% coverage.

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 clearly states 'One-shot reader for the active document's key fields' and lists the specific fields (fps, min/max, loop range, etc.), distinguishing it from the sibling 'set_document' which is the writer side.

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 pairs with 'set_document' for the writer side, implying when to use this tool (reading vs modifying). This provides clear context, though it does not elaborate on when not to use it or alternatives beyond set_document.

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