deletePullRequestComment

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states 'delete a comment' without mentioning that deletion is irreversible, whether special permissions are required, what happens if the comment does not exist, or any side effects. This is a significant gap for a mutating operation.

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 that front-loads the core action. While it is appropriately brief for a simple delete operation, it sacrifices essential context in favor of brevity, making it less informative than ideal.

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 tool with four parameters, two undocumented, and no output schema, the description is inadequate. It does not explain the purpose of each parameter, how to identify the comment, expected success/failure behavior, or any prerequisites. An agent would have to rely on external knowledge to call this tool correctly.

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 only 50%—repo_slug and workspace have no descriptions in the schema, and the tool description adds no information about any parameter. The description does not explain how to obtain or use the IDs, nor does it clarify optional parameters. With low coverage, the description should compensate but does not.

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 the specific resource (a comment on a pull request), which unambiguously distinguishes it from sibling tools like addPullRequestComment and updatePullRequestComment. The verb-object structure leaves no doubt about the tool's purpose.

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?

Usage is implied by the name and description—use this tool when a comment needs to be removed from a PR—but there is no explicit guidance on when not to use it or which sibling tool to prefer in alternative scenarios. No alternatives are mentioned, so the agent must infer context from the action alone.

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