delete_comment

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

With no annotations, the description carries full burden but provides limited behavioral insight. It mentions that deleting 'anterior/posterior' types deletes all lines, which is useful context, but lacks details on permissions, reversibility, error conditions, or what happens to the data. For a destructive operation, this is insufficient.

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 extremely concise with two sentences that directly convey core information without fluff. It's front-loaded with the main action and efficiently adds a behavioral note.

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 destructive tool with no annotations and no output schema, the description is incomplete. It lacks critical details like success/error responses, side effects beyond line deletion, or dependencies. The context signals indicate moderate complexity (2 params), but the description doesn't adequately compensate for missing structured data.

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 description coverage is 100%, so the schema fully documents parameters. The description adds minimal value by implying 'address' targets a comment and hinting at 'comment_type' effects for 'anterior/posterior', but doesn't elaborate beyond schema details. Baseline 3 is appropriate given high schema coverage.

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') and target ('a comment at the specified address'), making the purpose evident. However, it doesn't explicitly differentiate from sibling tools like 'set_comment' or 'get_comments' beyond the verb 'delete'.

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. The description mentions behavior for 'anterior/posterior' types but doesn't explain when to choose this over other comment-related tools or prerequisites for deletion.

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