hwp_find_replace

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

With no annotations, the description bears full responsibility. It mentions regex and case sensitivity but does not disclose whether the replacement affects all occurrences, the selection, or the entire document. No mention of side effects, return value, or state changes.

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 concise with two sentences. It front-loads the core action and clarifies options. Could be slightly more structured but is efficient.

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?

Given no output schema, the description does not mention return values (e.g., success count). For a relatively simple tool with 4 parameters, it covers the basics but lacks completeness regarding outcomes and behavioral scope.

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 100% and descriptions are already informative. The description reinforces the usage of 'use_regex' and 'case_sensitive' but adds minimal new value beyond the schema. Baseline of 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?

The description clearly states the operation: find and replace text in the entire document. It mentions regex and case-insensitive options, making the purpose specific to a text replacement tool. However, it does not differentiate from sibling tools like 'hwp_find_replace_multi' or 'hwp_find_replace_nth'.

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 guidance is provided on when to use this tool versus alternatives such as 'hwp_find_replace_multi' for multiple patterns or 'hwp_find_replace_nth' for specific occurrences. The description lacks contextual cues for selection.

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