get_file_outline

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

No annotations provided, so the description carries full burden. It mentions 'from the index' but does not clarify dependencies (e.g., prior indexing), error behavior (e.g., file not indexed), or whether it is read-only. Lack of behavioral details reduces transparency.

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?

One sentence, 19 words, no fluff. Front-loaded with verb and key outcome. Each word is meaningful.

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?

No output schema, so description could hint at output structure (e.g., hierarchical list). It adequately describes input but lacks return format details. Given low complexity (1 param), it is somewhat complete but could be improved.

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 100% for the single 'filePath' parameter. The description adds minimal value beyond the schema (e.g., 'from the index'), so baseline 3 applies. No additional parameter nuances are provided.

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 verb ('Returns'), resource ('structured outline of all symbols'), and scope ('from the index'). It distinguishes from siblings like 'find_definitions' and 'get_call_graph' by focusing on a single file's declarations.

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?

No guidance on when to use this tool versus siblings (e.g., 'find_definitions' or 'semantic_query'). The description implies a specific use case but does not explicitly state contexts or exclusions.

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