search_symbols

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

No annotations exist; description carries full burden. Discloses search behavior, output format (list with locations), pagination, and prerequisite. Implies read-only operation.

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?

Well-structured with separate sections for description, usage, examples, pagination, and note. Each sentence adds value; no redundancy.

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?

Comprehensive for a search tool with 4 params, 100% schema coverage, and no output schema. Includes prerequisite and pagination. Could mention case sensitivity or performance but not essential.

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 covers 100% of parameters; description adds value with glob pattern explanation and examples for query and kind usage, plus pagination offset context.

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 for types, methods, fields by name pattern with glob support. Examples distinguish it from many sibling tools focused on specific analyses.

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 prerequisite ('requires load_project to be called first'), usage examples, and pagination guidance. Does not discuss when to use alternatives or when not to use.

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