get_document_symbols

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

No annotations are present, so the description must carry the behavioral burden. It declares the tool returns a hierarchical list or error, but does not explicitly state it is read-only or disclose any side effects. The behavior is implicitly safe but not confirmed.

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 extremely concise, using a single sentence for purpose followed by structured Args and Returns sections. No wasted words; every sentence is necessary.

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 presence of an output schema (implied by 'Has output schema: true'), the description sufficiently summarizes the return value as 'Hierarchical list of symbols or error message'. For a tool with moderate complexity and clear parameters, this is nearly complete.

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 description coverage is 0%, so the description must add meaning. It clearly describes both parameters as 'Absolute path to Dart project root' and 'Absolute path to Dart file', which adds valuable context beyond the schema's type and title. However, it could specify that the project path should point to the root containing pubspec.yaml.

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 retrieves all symbols (classes, functions, variables) from a Dart file, using a specific verb and resource. It distinguishes itself from sibling tools like 'find_references' and 'go_to_definition' by focusing on listing all symbols in a given file.

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 provides no guidance on when to use this tool versus alternatives. It does not mention prerequisites, context, or limitations, leaving the agent without decision-making support.

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