Search Tiendanube / Nuvemshop docs

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context beyond that: docs are fetched live from nuvemshop.dev, results include URLs, and the top three can include the best matching section.

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 two tight sentences with no wasted wording. It front-loads the tool's purpose before moving to return behavior and the follow-up workflow.

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?

For a four-parameter, read-only search tool with full schema coverage and no output schema, the description supplies the missing return-shape context, names the live source, and routes the agent to read-doc for follow-up. Nothing essential for selecting or invoking it appears to be missing.

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 100%, so the input schema already documents query, limit, locale, and excerpts, including defaults and bounds. The description adds no parameter-level meaning beyond what the schema provides, which makes the baseline 3 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 states a specific verb and resource: searching the official Tiendanube / Nuvemshop developer docs, fetched live from nuvemshop.dev. It lists the covered doc areas and explicitly names read-doc as the follow-up tool, so an agent can distinguish it from that sibling without opening the schema.

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?

It gives clear when-to-use guidance: use this first for any 'how do I' question, then follow up with read-doc. It does not explain when to prefer the structured lookup siblings such as lookup-endpoint, lookup-scope, or lookup-webhook-event, so the alternative-routing guidance is not exhaustive.

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