symbol_search

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

No annotations are provided, but the description explains the hybrid semantic and keyword search nature, which is a behavioral trait. However, it does not disclose details like result ranking, limits, or side effects. Without annotations, the description carries the burden but is somewhat thin.

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 a single sentence that effectively captures the core functionality without waste. It is front-loaded and concise.

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 tool searches over all symbols, one would expect details on how to formulate queries (e.g., what parameters to provide), result format, and maybe limitations. The description and schema are minimal, and with no output schema, the agent lacks important context.

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?

The schema has no defined parameters, and description doesn't explain how to specify search queries. Since the schema is effectively empty (additionalProperties true but no defined properties), the description doesn't compensate for the lack of parameter semantics. The agent would need to infer how to pass the search term, which is a gap.

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 performs a hybrid semantic + keyword search over all symbols in the repository, which is specific. It distinguishes from siblings like get_definition, get_context, find_pattern, which are more targeted, though it doesn't explicitly name alternatives.

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 implies usage for general symbol discovery, but does not provide explicit when-to-use vs alternatives or exclusions. Given the context of many sibling tools, more guidance would help but it's acceptable.

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