Search Shortcut Epics

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It does not state that this is a read-only operation, nor does it explain what 'query syntax' entails, how results are returned, or any potential side effects. This leaves safety and expectations unclear.

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 sentence with no wasted words, making it concise and front-loaded. However, it lacks structure such as examples or parameter hints, though it remains appropriately sized for the minimal information it conveys.

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 no output schema, no annotations, and incomplete parameter documentation, the description is insufficient. It does not explain return values, pagination, or the behavior of dry_run, making it incomplete for a search tool that likely needs clarification on these aspects.

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?

The input schema documents only the 'query' parameter (33% coverage), and the dry_run and page_size parameters are unannotated. The description adds no extra meaning about these parameters, especially the non-obvious dry_run flag, leaving their semantics unexplained.

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 identifies the action (search) and resource (Shortcut epics), and the phrase 'query syntax' hints at a search interface. It is distinguishable from sibling list_epics which likely lists all epics without a query, though it does not explicitly contrast with search_stories.

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 gives no guidance on when to use this tool over alternatives like search_stories or list_epics. It does not mention any prerequisites, context, or situations where this tool is preferred, leaving the agent without direction.

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