list_symbols

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

Declares read-only behavior and specifies supported languages and return content (line numbers, formatted outline). Lacks mention of error handling for invalid paths or unsupported languages, but overall transparent.

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?

Four concise sentences plus an example, no fluff. Information is front-loaded: purpose, usage, anti-usage, example. Every sentence adds unique value.

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 purpose, usage, parameter example, and output format. Has output schema so return description is sufficient. Complete for a simple list tool with one parameter.

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?

Adds context beyond the schema by providing an example and stating the file should be a source file in supported languages. Schema coverage is 0% so description compensates adequately.

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 formatted outline of top-level symbols with line numbers for multiple languages. It distinguishes itself from sibling tools that modify or delete symbols.

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 provides when to use (before editing unfamiliar files) and when not to use (already know target name). Recommends it as a first call to avoid guessing, which is actionable guidance.

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