noir_search_code

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

With no annotations, the description carries full burden. It mentions regex support and scope (all cloned repos), but lacks details on return format, performance implications, or any read-only guarantees. Adequate but not comprehensive.

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?

Three sentences: purpose and scope, feature (regex), and use cases. No waste, front-loaded, easy to read. Every sentence earns its place.

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 4 parameters and no output schema, the description covers purpose, scope, features, and typical use. Missing explicit statement that only .nr files are searched by default (though filePattern default is in schema) and no details on output format. Mostly complete.

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%, so baseline is 3. The description adds context that the search is across all cloned repos and highlights regex for the query, providing value beyond schema. However, it does not significantly elaborate on other parameters.

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 searches Noir source code across all cloned repos, specifies supporting regex patterns, and gives use cases (finding function implementations, patterns, examples). This distinguishes it from siblings like noir_search_docs or noir_search_stdlib.

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 implicitly guides usage by focusing on source code search, but does not explicitly state when not to use it or mention alternatives like noir_search_docs for documentation or noir_search_stdlib for standard library. No exclusions provided.

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