search_data

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

Beyond the readOnlyHint annotation, the description discloses that results are column-level IDs pointing to where to look, not the data itself. It also reveals the max_results cap and the requirement for an embedding provider via specific environment variables, adding valuable behavioral context.

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 three sentences, each earning its place: purpose, return semantics plus usage, and key constraints. It front-loads the primary action and is free of redundant detail.

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?

The description covers the tool's purpose, return value shape, workflow guidance, a critical limit, and semantic mode requirements. With no output schema present, it still explains what the caller receives. Given 7 parameters all documented in the schema, this is complete for a read-only 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?

Schema coverage is 100%, so baseline is 3. The description adds value by clarifying max_results is capped at 50 (schema only shows default 10) and by naming the specific embedding provider environment variables, which is not in the schema. This goes beyond the schema, meriting a 4.

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 searches across column names and values, using a specific verb and resource. It further distinguishes itself by noting it returns column-level results with IDs, not the data itself, differentiating it from data retrieval tools.

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?

Explicitly mentions 'Use before get_rows or describe_column', naming specific alternative tools and the intended ordering. It also provides constraints (max_results capped at 50) and prerequisites for semantic search, giving clear context for when to use the tool.

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