Github Add Inline Pr Comment

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

Annotations already indicate a write operation, but the description adds valuable behavioral context: GitHub will reject comments on unchanged lines outside hunks or on paths not in the diff, and deleted lines exist only on side LEFT. This goes beyond the structured annotation hints and helps the agent anticipate failures.

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?

Three sentences, with the core purpose first and the critical constraints following. Every sentence contributes meaningful guidance and there is no filler or repetition of the name.

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 9-parameter tool, the description covers the most error-prone constraints (diff hunks, side usage, range support) and the output schema is present to handle return details. It does not enumerate every parameter, but the self-explanatory names and schema descriptions cover the rest, making the description reasonably complete.

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?

With schema description coverage at only 33%, the description compensates partly by explaining line/range semantics and the LEFT side for deleted lines. However, it does not add semantics for path, comment_body, or the repo identifiers, though those are fairly inferable from names. The low coverage keeps this from scoring higher.

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 states a specific action ('Adds an inline review comment'), a precise resource ('a line, or a range of lines, in a file within a PR'), and adds scope by explaining the diff-hunk requirement. It clearly differentiates this from sibling tools like github_add_pr_comments by emphasizing 'inline' and line/range targeting.

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 gives actionable preconditions: the target line must be inside a diff hunk, the path must be in the diff, and deleted lines require side LEFT. It does not explicitly name alternative tools, but the 'inline' and 'line/range' framing implies when this tool is appropriate versus general PR comment tools.

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