replace_paragraph

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

The description discloses that the tool modifies content and formatting, indicating a write operation. However, no details are given about side effects, return values, or error handling. With no annotations provided, the description carries the full burden but only partially fulfills it.

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 structured with a clear purpose line followed by a parameter list. It is not overly verbose, but the parameter list somewhat duplicates schema information. The first sentence front-loads the core action.

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?

While parameter explanations are provided, the description omits important context such as return value, error scenarios (e.g., invalid paragraph index), and file handling requirements. Given the tool's complexity and lack of annotations, more completeness is needed.

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 'Args' section provides Chinese explanations for each parameter, adding unit information (e.g., font size in pt, indent in characters) that is not present in the schema titles. This compensates for the schema's lack of descriptions, though some explanations are merely translations of parameter names.

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 '替换指定段落的内容，并应用新的格式' (Replace content of specified paragraph and apply new formatting), specifying the verb and resource. It distinguishes from siblings like insert_paragraph_after and delete_table by focusing on replacement of an existing paragraph by index.

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. There is no mention of prerequisites, error conditions, or situations where other tools (e.g., search_and_replace) would be more appropriate.

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