Get outline (scenes, sections, synopses)

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

No annotations are provided, so the description carries full responsibility. It discloses that the operation is a read-only 'get', what data is returned, and the ordering of the outline. It does not cover error cases or behavior when no document is open, but the core behavioral profile is clearly conveyed.

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, information-dense sentence that front-loads the verb and object, then packs in the result contents, ordering, and downstream usage. Every phrase earns its place 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 simple read-only tool with one optional parameter and no output schema, the description is complete: it says what is returned, in what order, and how the result feeds sibling tools. The optional document targeting is covered by the schema, so nothing essential is missing.

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 input schema already describes docIndex fully, including its source list and default behavior when omitted. The description adds no parameter-specific detail, so it settles at the baseline score for high schema 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?

States a specific verb ('Get') and resource ('full outline of a Beat document'), then enumerates exactly what is included: scene headings, sections, synopsis lines, and order. It also distinguishes itself from scene-only tools by explicitly mentioning the sceneIndex and its downstream consumers.

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?

Clearly implies when to use this tool: to retrieve the complete outline and obtain the sceneIndex needed by beat_get_scene_text/beat_replace_scene. It does not explicitly state when not to use it or contrast it with siblings like beat_get_scenes, so it stops short of a full 5.

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