Search VIPMP docs

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds valuable behavioral context: results ranking method, dependence on caching for content matches, and that returns 'most query-relevant sections' instead of blunt cutoff. No contradiction with annotations.

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 fairly concise with two paragraphs plus an Args section. It front-loads the purpose. The Args section could be integrated to reduce repetition, but overall it's efficient and well-structured.

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 has 2 parameters, an output schema exists, and the description explains caching behavior and return format (titles, paths, relevant sections), it covers key aspects. Minor gap: no mention of empty result handling, 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 0%, so the description carries full burden. It explains 'query' with examples like 'create order', 'oauth token', and 'max_results' with default and max value (5 and 10) which goes beyond the schema's basic type/default. This provides clear meaning for both parameters.

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 the resource 'Adobe VIP Marketplace API documentation by keyword or topic'. It specifies how results are ranked (title/tag + content matches) and distinguishes from sibling tools like list_vipmp_docs (which lists docs, not search) and get_vipmp_page (specific page retrieval).

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 explains when to use the tool (to search docs by keyword/topic) and mentions a prerequisite (call warm_vipmp_cache for strongest results). However, it does not explicitly state when not to use it or directly compare to siblings like list_vipmp_docs for browsing or get_vipmp_page for single-page lookup.

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