Search @imqueue documentation

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

No annotations provided, so description carries full burden. It discloses return format (pages with URLs) but lacks details on pagination, empty results, or rate limits. For a search tool, behavior is fairly transparent, but could be more thorough.

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 sentences, front-loaded with action and resource, no extraneous words. Every sentence adds value: first states what it does, second provides usage sequence.

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?

No output schema, but description mentions return format (pages with URLs). For a search tool, it covers key aspects: query input, result type, and integration with sibling. Could mention sorting by relevance, but not critical.

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. The description adds concrete examples for the query parameter ('e.g. 'expose a service method' or 'delayed jobs''), offering extra context beyond the schema. The limit parameter gets a default noted, but schema already provides details.

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 uses a specific verb ('Search') and resource ('@imqueue docs'), and explicitly mentions returning 'most relevant pages with their URLs'. It distinguishes itself from sibling tools by advising to use this first, then get_doc.

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?

Explicitly states 'Use this first when asked how to do something in @imqueue, then get_doc to read a page in full.' This provides clear guidance on when and how to use this tool versus its sibling get_doc.

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