outline

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

With no annotations, the description must communicate behavioral traits. It mentions the 'prepared fast-query substrate,' hinting that the file must be indexed, but it doesn't explain what happens if the file is not indexed or how errors are handled. The read-only nature is implied but not explicitly stated.

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 concise sentences: the first states the primary action and result, the second gives the use case. No filler or repetition. Front-loaded with the verb and object.

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 single-parameter tool with no output schema, the description covers what it does, when to use it, and what the outline contains. It does not explicitly state that the file must be indexed beforehand, but the phrase 'prepared fast-query substrate' partially implies it. Overall, quite complete for its complexity.

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 description coverage is 100%, so the schema already documents the file_path parameter well. The tool description adds no further parameter-level details beyond the schema's own description. Baseline 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 opens with a specific verb ('Return') and resource ('compact file outline'), and clarifies the content (imports, exports, symbols). It distinguishes itself from sibling tools by explicitly noting this is for a known file and avoids broader search or full-body reads.

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 provides a clear 'when to use' statement ('when you know the file and want imports, exports, and symbols') and implies exclusions ('without broader search or full-body reads'). However, it does not name alternative tools explicitly, which would have earned a 5.

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