find_replace_formatted

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

Provides behavioral detail (formatting applied only to replacement run, all paragraphs). With no annotations, the description adds context but omits side effects (e.g., track changes, read-only handling) and error conditions (e.g., find not found).

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?

Structured with a brief summary, then detailed behavior, then parameter listing. Front-loaded and efficient, though the Args block is somewhat verbose but appropriate for parameter clarity.

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?

Covers parameters and core behavior well, but lacks return value description (output schema exists but not shown), scope limitations (only main paragraphs?), and error handling. Adequate but not fully comprehensive.

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 0%, so description fully compensates with explicit Args section explaining each parameter's effect, including tri-state behavior for boolean/null parameters. Adds meaning beyond schema types.

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?

Clear verb ('Find and replace') with specific resource ('formatted text') and explicit scoping ('across all paragraphs'). Distinguishes from sibling tools like 'replace_text' by emphasizing formatting application to the replacement.

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 guidance or exclusion of alternatives. The description implies use for formatted find/replace, but does not contrast with 'replace_text', 'bulk_replace_text', or other sibling tools.

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