find_and_replace

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

With no annotations, the description must disclose behavioral traits. It mentions mutation (replace) and return value, but does not explain side effects (e.g., formatting preservation, undo capability), behavior with zero matches, or the effect of the 'regex' parameter. This leaves key behaviors unspecified.

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 very short (one main sentence plus return note) and front-loads the core action. However, its brevity sacrifices critical details, making it somewhat under-specified rather than purely concise.

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 is incomplete for a tool with 4 parameters, no output schema, and no annotations. It omits parameter details, prerequisites (e.g., document must be open), behavior of the 'regex' option, and return format. The agent lacks sufficient context for correct invocation.

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 property descriptions are absent (0% coverage). The description only names 'search' and 'replace' but does not explain the 'doc_id' parameter's role, the 'regex' boolean's effect, or any constraints. The agent cannot infer the full parameter semantics from the description alone.

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 verb 'Replace', the resource 'document', and the specific action of replacing occurrences of `search` with `replace`. It also notes the return value (count replaced), making the tool's purpose unambiguous and distinct from siblings like insert_text or get_text.

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?

The description provides no guidance on when to use this tool versus siblings (e.g., insert_text, set_paragraph_style). No prerequisites, limitations, or alternative suggestions are mentioned. The agent must infer usage context from the name alone.

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