read_file_outline

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

Explicitly states 'Read-only; no side effects, auth, or rate limits,' covering safety and performance characteristics even though no annotations are provided. This adds valuable behavioral context beyond structured fields.

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?

Two sentences, no wasted words. First sentence states purpose and return format; second sentence gives usage guidance. Front-loaded and efficient.

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?

Covers return format (list of headings with fields), edge case (empty outline), and fallback options. With one parameter and no output schema, the description is fully adequate.

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?

Only one parameter (file_id) with full schema coverage. The description adds no additional meaning to the parameter itself beyond what the schema provides. Baseline of 3 is appropriate.

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 the tool returns a flat list of markdown headings for one file, with specific fields (level, text, line, byteStart, byteEnd). It distinguishes itself from siblings like read_file, read_section, and update_file_section by positioning itself as a cheap probe.

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?

Explicitly advises using it as a cheap probe before read_section or update_file_section to avoid token waste, and provides fallback guidance (empty outline -> use read_file or read_file_lines). Includes when-not-to-use and alternatives.

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