Github Add Inline Pr Comment

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

It discloses key non-obvious behavior: GitHub rejects comments on non-hunk lines or non-diff paths, and deleted lines exist only on side LEFT. These constraints go beyond the annotations (readOnly=false, destructive=false, idempotent=false) and help the agent predict failure modes.

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 short sentences, each carrying essential information: the action, the diff-hunk validation constraint, and the workflow pointer. It is front-loaded and has no filler, making it easy for an agent to skim and retain.

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?

The core call constraints are covered, and an output schema exists so return-value explanation is unnecessary. The only gaps are minor: no explicit handling of start_line/start_side edge cases or a clear alternative routing, but the description plus schema and annotations are otherwise sufficient for correct invocation.

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 only 33% schema description coverage, the description compensates by explaining the line/range relationship and the LEFT side for deleted lines. It also clarifies that the path and line must be part of the diff. Obvious parameters like repo_owner, repo_name, pr_number, and comment_body are self-explanatory and need little extra prose.

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 identifies the action ('Adds an inline review comment') and object ('to a line, or to a range of lines, in a file within a PR'), so an agent can tell what it does. It does not explicitly call out how it differs from github_add_pr_comments or github_reply_to_review_comment, but the 'inline' and line/range scoping is enough to infer the distinction.

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 strong contextual guidance: comments are only valid inside PR diff hunks, unchanged lines outside hunks are rejected, and deleted lines must use LEFT. It stops short of naming alternatives or stating when not to use the tool, and the github_get_skill('pr-review') reference is indirect workflow guidance.

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