Fuzzy search

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

Discloses behavior beyond annotations: reports available=false if pg_trgm missing, describes return structure (object with available, matches, mode). Annotations already indicate readOnlyHint=true, so no contradiction.

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 sentences plus example, no wasted words. Front-loaded with verb and resource. Every sentence adds value.

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?

Explains core functionality, modes, and gives example. However, missing parameter details for limit and threshold. Output schema exists but not shown. Adequate but with gaps for a tool with 8 parameters.

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?

Defines mode parameter and provides an example covering schema, table, column, term, mode. However, limit and threshold are not explained despite low schema coverage (13%). Database parameter has schema description but missing from description.

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?

Description clearly states it ranks a text column by pg_trgm trigram similarity to a search term, with specific mode options ('word' vs 'full'). This distinguishes it from sibling search tools like full_text_search.

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?

No explicit when-to-use or when-not-to-use guidance. Agent can infer usage for fuzzy matching, but no contrast with sibling tools or mention of prerequisites beyond pg_trgm availability.

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