n3mo_search_symbol

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

No annotations are provided, so the description must disclose behavioral traits. It states that the tool searches for the 'exact location and definition' of a symbol, but does not clarify what that entails (e.g., file path, line number, or code snippet). The description is adequate but lacks detail about the search behavior or output format.

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 of 14 words, highly concise and front-loaded with the core purpose. No extraneous information or redundant phrases.

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?

Despite the tool's simplicity, the description fails to specify what the tool returns (e.g., file path, line number, code snippet). It also does not mention that the codebase must be indexed beforehand. Given the lack of an output schema, this information is essential for the agent to use the tool correctly.

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 100%, and both parameters have descriptions in the input schema. The tool description adds no additional meaning beyond what the schema already provides (e.g., it does not elaborate on the 'project_path' parameter or provide examples). Baseline score is 3.

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 verb 'Search', the resource 'indexed codebase', and the object 'symbol (class or function)', with the aim of finding its exact location and definition. It is distinct from sibling tools like n3mo_get_dependencies or n3mo_get_file_symbols, which have different purposes.

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?

No guidance is provided on when to use this tool versus alternatives such as n3mo_get_file_symbols or n3mo_get_blast_radius. The description does not specify prerequisites (e.g., the codebase must be indexed first) or scenarios where this tool is preferred.

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