search_source

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

Discloses behavior: uses GitHub API, returns up to 10 results with file name, path, URL. Notes authentication requirements and rate limits. Lacks detail on error handling or edge cases, but is adequate given no annotations.

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?

Reasonably concise with a clear structure: main description followed by argument explanations. No extraneous information, though could be slightly more streamlined.

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?

Covers purpose, parameters, output format, and authentication. Given the tool has only 2 parameters and no annotations, the description is largely complete. Missing error conditions or version scope, but acceptable.

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?

Input schema has no descriptions (0% coverage). The description adds meaning: 'package' is a package name from list_packages(), 'query' is a search string example. Provides helpful context beyond the schema.

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 GitHub source code of a package for a query string using the GitHub Code Search API. It specifies the verb 'search' and resource 'source code of a package', and distinguishes from sibling tools like search_docs and get_function_source.

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 clear context: requires GITHUB_TOKEN, rate limits (5000 vs 60 req/hr). However, does not explicitly state when to use this versus alternative sibling tools like search_docs or get_function_source, though the purpose differentiation is implied.

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