delete_pr_comment

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

There are no annotations provided, so the description must disclose behavioral traits. It only states 'Delete a PR comment' without revealing whether the deletion is permanent, what permissions are required, or how errors are handled. The destructive nature is implied but not elaborated, and there is no mention of reversibility or side effects.

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, leading with a clear one-sentence purpose and followed by a compact parameter list. There is no extraneous text or repetition of schema details, making it efficient for an agent to parse quickly.

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 the absence of annotations and an output schema, the description is too sparse to provide a complete picture. It does not mention error behavior, idempotency, or whether workspace/repo are required in context. For a destructive operation, the agent would benefit from knowing what happens on failure or if the comment does not exist, but such details are omitted.

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 schema description coverage is 0%, so the description carries the burden of explaining parameters. It lists all four arguments with brief glosses (e.g., 'Comment ID to delete', 'Workspace slug', 'Repository slug'), which adds some clarity beyond the raw schema. However, it does not explain that pr_id is the ID of the containing PR, nor does it note that workspace and repo are optional (defaulting to empty strings), leaving some interpretation to the agent.

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 a PR comment.' This is a specific verb (delete) plus resource (PR comment), leaving no ambiguity about the tool's function. It also distinguishes itself from sibling tools like edit_pr_comment or reply_to_pr_comment, which serve different purposes.

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 explicit guidance on when to use this tool versus alternatives. It does not mention exclusions, prerequisites, or scenarios where a different tool might be more appropriate. With many sibling tools for commenting, such as edit_pr_comment and comment_on_pr, this lack of differentiation guidance makes it hard for an agent to choose confidently.

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