Github Search Issues

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive nature. The description adds the behavioral detail of returning 'redacted summaries,' which is not captured by annotations. However, it does not disclose auth requirements, rate limits, or what redaction entails.

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 concise sentence that is front-loaded with the action and resource. It efficiently conveys the core purpose, though additional guidance could be added without significant bloat.

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?

With an output schema present, return values need not be explained. However, the description lacks context on how to effectively use the search (e.g., query syntax, what 'redacted summaries' contain). Given the tool's moderate complexity (4 parameters), the description is incomplete.

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 low (25%), only the 'repo_alias' parameter has a description. The main description mentions 'configured repo alias' but provides no details on 'query', 'limit', or 'state' parameters. The description fails to compensate for the lack of schema explanations.

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' on the resource 'GitHub issues' with additional context about using a configured repo alias and returning redacted summaries. This distinguishes it from sibling tools like 'redctx_github_list_issues' (listing without search) and 'redctx_github_read_issue' (reading a single issue).

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 query-based searching but does not explicitly state when to use this tool vs alternatives like 'redctx_github_list_issues' or 'redctx_github_read_issue'. No exclusions or when-not-to-use guidance is provided.

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