Find Blocks By Name

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

The description discloses a meaningful behavioral limitation: only the backend's default 200 INSERTs are scanned, and the compact envelope's total counts only references found within that scan. This adds real context beyond the readOnlyHint annotation and helps set accurate expectations about completeness and truncation.

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 compact, front-loaded with the core purpose, and the follow-up sentence about the scanning limit earns its place. There is no redundant restatement of the title or schema.

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 read-only query tool with a rich input schema and an output schema, the description covers the essential behavioral caveat, return-shape nuance, and purpose. Nothing critical is missing for an agent to invoke it correctly.

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 already provides full descriptions for all three parameters, including the compact envelope shape and the fields projection syntax. The description adds some nuance about the compact total field, but it does not meaningfully explain parameter usage beyond what the schema already documents, so the baseline 3 applies.

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 states a specific action—'Find all insert references to a specific block definition'—with a clear verb and resource. It naturally differentiates itself from sibling tools like block_list, which lists block definitions, by focusing on references to a definition.

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?

There is no explicit guidance about when to use this tool versus alternatives, nor any mention of when not to use it. The sibling set includes block_list and entity_list, but the description never explains how this tool relates to them or when one should be preferred.

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