Docs: Lookup Topic

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

With no annotations, the description carries the full burden of behavioral disclosure. It discloses the return composition (tutorials, related docs, API endpoints), the 'single-call' nature, and positions itself as an entry point. It does not explicitly mention read-only status, response size, or error handling, which keeps it from a 5.

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 three concise sentences, is front-loaded with 'START HERE', and each sentence has a clear purpose: define the tool, give usage guidance with examples, and indicate when to use alternatives. No wasted words.

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?

Given the tool's simplicity (one parameter, no output schema, no annotations), the description covers the essential context: purpose, when to use, return types, and relationship to sibling tools. It is complete enough for an agent to select and invoke correctly.

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 schema already covers 100% of the one parameter 'topic' with a description, so the baseline is 3. The description adds extra value by providing example topics ('order redemption', 'referral', 'points') and explaining how the parameter is used in a broad question, going beyond the schema's generic definition.

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 tool's function: 'Comprehensive single-call lookup that returns tutorials, related docs, AND relevant API endpoints for a topic.' It uses a specific verb and resource, and explicitly distinguishes itself from siblings by saying 'Use this first' and 'Only use the other tools if you need to drill deeper into a specific page or endpoint.'

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 explicit when-to-use guidance: 'Use this first for any broad question' with concrete examples like 'how to create an order with redemption' and 'referral setup'. Also gives an exclusion: 'Only use the other tools if you need to drill deeper into a specific page or endpoint.' This clearly covers usage versus alternatives.

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