Delete pull request comment

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

With no annotations, the description carries the full burden of behavioral disclosure. It discloses that the delete is a 'soft-delete' (implying reversibility or non-permanent nature), notes permission rules, and requires confirmation and write tools. This conveys the mutation nature and safety requirements. It does not detail the exact outcome or return value, but the provided behavioral traits are valuable and go beyond a simple 'deletes a comment'.

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 three sentences with no waste. The primary action is front-loaded, followed by necessary constraints. Every sentence contributes information: the action, the permission context, and the confirmation requirement. It is concise and well-structured.

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 tool has six parameters, no output schema, and no annotations, the description covers the core purpose and key constraints but omits some context. It does not mention what happens after the soft-delete (e.g., whether the comment is hidden or recoverable), nor does it describe the response format. However, the essential information for an agent to decide to call the tool is present. The description is adequate but not exhaustive.

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 83%, so most parameters are already documented. The description reinforces the 'confirm' parameter by stating confirm=true is required, adding context to its purpose. However, it does not add meaning to other parameters like threadId or commentId beyond what the schema provides. The description's mention of 'top-level or reply' implies the commentId is a specific comment within a thread, but this is already implied by the schema. The added value is minimal, consistent with the 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: 'Soft-delete a top-level or reply comment inside a pull request thread.' It identifies the resource (comment) and scope (top-level or reply, within a PR thread), which distinguishes it from other comment tools like delete_work_item_comment or update_pull_request_comment. The purpose is specific and unambiguous.

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 context about Azure DevOps author and permission rules and requires confirm=true, which are usage constraints. However, it does not explicitly name alternative tools or state when not to use this tool. It implicitly tells the agent when to use it (to delete a PR comment) but lacks exclusions or comparisons with siblings. This is clear context but not fully explicit guidance.

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