Search Code Tool

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

readOnlyHint=true already tells the agent this is a safe read, so the description carries a lower burden. It adds the syntax hint but says nothing about the notoriously tight rate limits on GitHub code search, result caps, or pagination traversal behavior. Net: a modest value-add beyond annotations, with real gaps left.

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?

Two short sentences, purpose front-loaded, example immediately after. Nothing wasted, nothing pruned to the point of vagueness.

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?

An output schema exists, so return values need no explanation, and all three parameters are documented. The remaining gap is operational: no mention of rate limiting or how to page through large result sets for a search tool where both matter.

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 coverage is 100%, so baseline is 3, but the description earns a bump by supplying a concrete query example ("addClass repo:jquery/jquery") that teaches the qualifier syntax the schema's terse "Search query string" does not. It does not address page/per_page, but those are self-documented.

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?

States a specific verb and resource: "Search for code across GitHub." An agent can distinguish it from the issue-oriented siblings (search_issues_tool, list_issues_tool) and from read-only file tools (get_file_content_tool), though the description never explicitly names those 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?

Usage is implied by the pointer to GitHub code search syntax and the sample query, which tells the agent how to phrase a query but not when this tool beats list_repo_tree_tool or get_file_content_tool. No when-not or exclusion guidance is given.

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