manage_commit_comments

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

The description claims a delete action, which is destructive, but the annotations set destructiveHint to false. This is a direct contradiction, as the tool can delete comments. Additionally, no other behavioral traits (auth needs, side effects) are disclosed, so transparency is poor.

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 two sentences with no filler. It front-loads the purpose and actions, making it easy to scan. Every word earns its place.

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 7 parameters and no output schema, the description does not explain return values or behavior in edge cases (e.g., what happens on delete of non-existent comment). It covers the basics but leaves gaps for a moderately complex tool.

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?

Input schema has 100% coverage with descriptions for all parameters. The description adds minimal extra context by stating which actions require which parameters (e.g., version for edit/delete). This is helpful but largely redundant with the schema descriptions, so baseline 3 is appropriate.

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 that the tool manages comments on a commit with specific actions (create, edit, delete), providing a clear verb and resource. However, it does not differentiate from the sibling tool 'manage_comment', which presumably handles comments on pull requests or other objects, so ambiguity remains.

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 lists the allowed actions but provides no guidance on when to use this tool versus alternatives like 'manage_comment' or when not to use it. It lacks explicit context or exclusions, leaving the agent to infer usage without direction.

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