Search Api

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

Annotations already declare readOnly/idempotent/closed-world, so safety is covered; the description adds that results come from a fixed 21.1 stub, which tells the agent results are static documentation rather than live state. It does not mention result truncation via the default limit of 20, which matters for a search tool.

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?

Two short sentences, purpose first, alternative second; no filler. Every clause carries either scope or routing information.

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?

Output schema exists so return values need not be described, and the discovery-versus-execution split is stated. Minor gap: nothing says whether matching is case-sensitive or how results are ordered/capped, which affects interpreting a hit list.

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 50%: pattern is documented in the schema, limit is not. The description's "by name or description" reinforces that pattern matches substring across classes, methods and descriptions, but adds nothing about limit or result ordering. Baseline 3 is appropriate.

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?

States a specific verb and resource ("Search the Resolve scripting API ... by name or description") and scopes the corpus as the official 21.1 stub. It also routes the agent away from the domain tools, so an agent can distinguish it from describe_action and the *_read/*_write siblings without opening schemas.

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?

Gives explicit when-to-use ("check what Resolve itself can do") and an exclusion with the alternative named ("to call something, use the domain tools"). No guidance on when to prefer describe_action directly, but the split between discovery and execution is clear.

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