zenhub_search_issues

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

With no annotations provided, the description must fully disclose behavior. It lacks information about return format, pagination, performance constraints, or any side effects. Only the basic function is stated, which is insufficient for a search tool.

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 communicates the core functionality without extraneous content. Every word contributes to clarity.

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?

The description omits details about output format, result limits, sorting, and error cases. Given the nested filters parameter and absence of an output schema, the description is incomplete for an AI agent to reliably handle tool invocation.

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 67%, and the description lists the filtering dimensions (title, labels, assignees) already present in the schema. It adds no extra meaning beyond what the parameter descriptions already provide, so a baseline score of 3 is appropriate.

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 and filter' and the resource 'issues within a specific pipeline', with specific criteria 'title, labels, or assignees'. This distinguishes it from sibling tools like zenhub_search_issues_in_repository, which searches within a repository rather than a pipeline.

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 provides no guidance on when to use this tool versus alternatives such as zenhub_get_workspace_issues or zenhub_search_issues_in_repository. It does not indicate prerequisites or exclusions, leaving the agent to infer usage context.

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