search_pipeline

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

No annotations are provided, so the description carries the full burden. It discloses that the tool checks deployment status, returns search results, automatically stores output with an object ID, and can return error messages. This adds valuable context beyond a simple search.

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 somewhat verbose with repetition (e.g., 'Returns search results' and 'Returns a formatted preview'). It could be more concise by merging statements, but it is front-loaded with the core purpose.

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 two simple parameters and no output schema, the description covers the main behavior: deployment check, object ID storage, and integration hints. Lacks details on error types or pagination, but it is mostly complete for a basic search tool.

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 input schema has 0% parameter description coverage, but the description explicitly documents each parameter with clear meaning (pipeline_name, query). Although not exhaustive on formats, it sufficiently compensates for the schema gap.

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 it searches using a pipeline with a given query. However, it does not differentiate from sibling tools like search_pipeline_with_filters or search_pipeline_with_params, which might have more specific purposes.

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 implies usage when a pipeline is available and deployed (checks status) but does not provide explicit guidance on when to use this tool versus alternatives. No exclusions or preferred contexts are mentioned.

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