search_pipeline

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

Given no annotations, the description carries the full burden. It discloses that the pipeline must be deployed, returns search results or an error, automatically stores output with an object ID, and allows referencing in other functions. This covers key behaviors, though potential side effects or rate limits are omitted.

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 structured with logical sections (purpose, process, parameters, return info, storage guidance). However, it repeats itself slightly (e.g., 'Searches using a pipeline' and 'Uses the specified pipeline to perform a search').

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 search tool with two string parameters and no output schema, the description covers the return format (object ID), error handling, and integration with object store. It lacks details on result structure or pagination but is adequate for typical use.

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?

With 0% schema coverage, the description adds meaningful parameter descriptions: pipeline_name is explicitly linked to deployment check, and query is described as the search query. This adds value beyond the bare schema titles.

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 performs a search using a specified pipeline, including a deployment check. However, it does not differentiate from sibling tools like search_pipeline_with_filters or search_pipeline_with_params, which could cause confusion.

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 the process but provides no guidance on when to use this tool versus alternatives. There is no mention of prerequisites, exclusions, or scenarios where another tool would be preferred.

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