get_workspace_symbols

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

Describes read-only LSP search behavior, enrichment control, and pagination without side effects. No annotations exist, so description carries the burden, and it adequately discloses behavioral traits.

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?

Concise, front-loaded purpose, each sentence adds unique value. No redundancy or fluff.

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, parameters, and behavioral nuances adequately given no output schema. Implicitly suggests return is a list, but could explicitly state the result type.

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?

With 0% schema description coverage, the description fully compensates by explaining query, detail_level options, and limit/offset pagination mechanics in plain language, adding meaning beyond raw schema.

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?

Clearly states it searches symbols across the entire workspace via LSP, returning name, kind, and location. Distinguishes from sibling tools like get_document_symbols (document-scoped) and go_to_symbol (single symbol).

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?

Provides explicit guidance on detail_level options (omit/basic vs hover) and pagination with limit/offset to avoid re-running search. Lacks direct comparison to alternatives or when not to use, but context is clear.

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