search-apify-docs

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, indicating safe, idempotent reads. The description adds that results include URLs and limited content, and that search uses Algolia full-text search. This provides useful context beyond annotations, though no extensive behavioral detail is needed.

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 well-structured with bullet points and clear sections, but it is slightly verbose. However, every sentence adds value, and the most important information (main action and docSource selection) is front-loaded. A minor trim could improve conciseness.

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 4 parameters, output schema, and annotations, the description covers search behavior, docSource selection, query hints, pagination, and post-search actions. It is complete and sufficient for the agent to use the tool effectively.

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%, but the description goes beyond by explaining each docSource option in detail, advising to use keywords for the query parameter, and clarifying limit/offset semantics with pagination examples. This adds significant meaning beyond the schema.

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 purpose: searching Apify and Crawlee documentation using full-text search. The verb 'search' and resource 'documentation' are explicit, and the description distinguishes it from sibling tools like 'fetch-apify-docs' (which fetches full content) and 'search-actors' (which searches actors).

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 provides explicit guidance on when to use each docSource option with detailed bullet points, and includes a preference rule for platform documentation over Academy content. It also directs the user to use fetch-apify-docs for full content, offering clear context and alternatives.

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