inline_comment_on_pr

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

With no annotations, the description carries the behavioral burden. It discloses that the action adds a comment and includes important nuance like 'line number (on the new/right side of the diff)' and markdown support. However, it does not mention permissions, reversibility, or potential side effects beyond the obvious mutation.

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 concise: a one-sentence purpose followed by a compact arg list. Every listed item adds value, and the format is easy to scan.

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?

All parameters are explained and the output schema handles return values. The tool is well-specified for a straightforward comment action. Some minor gaps exist around explicit usage comparisons to sibling tools and permission prerequisites, but these are not critical.

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 0%, so the description must compensate. It provides clear explanations for all six parameters, including a concrete example for file_path and a note about the line side. This fully makes up for the schema's lack of descriptions.

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 opens with a specific verb and resource: 'Add an inline code review comment on a specific file and line in a PR.' It clearly distinguishes this from sibling tools like 'comment_on_pr' by emphasizing the inline, file-and-line-specific nature.

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 clearly implies when to use the tool: when you need to comment on a specific file and line in the diff. It does not explicitly name alternatives or exclusions, but the inline context is enough to differentiate it from general PR comments.

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