delete_paragraph

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

The description indicates the deletion uses 'revision mode,' suggesting a non-destructive tracked change. However, it does not detail what happens to the paragraph content (e.g., moved to revision history) or any required permissions. With no annotations, more behavioral context would be beneficial.

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 a single concise sentence with no extraneous text. It is front-loaded with the action and includes a cross-reference. While effective, it could be slightly more structured without adding length.

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?

For a delete operation with revision mode and three parameters, the description provides minimal but essential context. It references read_document for index but does not cover return values (though output schema exists) or reversibility. The description is adequate but not thorough.

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?

With 0% schema description coverage, the description must compensate. It explains the 'index' parameter via reference to read_document, but does not elaborate on 'path' or 'author' (default 'AI 律师助手'). The description adds some value for index but leaves other parameters unexplained.

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 action (delete paragraph) and the specific resource (paragraph at index 0-based), referencing read_document for index understanding. It distinguishes from siblings like insert_paragraph and replace_text by highlighting revision mode.

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 implies usage for deleting paragraphs by index but provides no explicit guidance on when to use this vs alternatives (e.g., replace_text or insert_paragraph). No exclusions or conditions are mentioned.

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