create_issue_comment_attachment

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

With no annotations, the description carries the full burden, and it succeeds: it discloses interaction with the local machine, user confirmation requirement, upload-path confinement, extension allow-list, sensitive-location avoidance, 50 MiB cap, default filename behavior, return value, and failure modes (404/413/422). This is unusually transparent for a tool of this type.

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 long but information-dense, touching on target, ID source, upload rules, local file safety, overrides, return value, and failure cases. Every sentence earns its place, though a few points (`file_path` reads a local file, `same shape and rules as create_issue_attachment`) could be more compact without losing value.

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?

With no output schema, the description provides the needed return information (“Returns the created attachment including its `id`”), and it also covers the important operational constraints and common risk scenarios. The combination of purpose, warnings, and failure modes makes the tool fully predictable without additional documentation.

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 coverage is 100%, and the description adds useful semantics beyond it: `comment_id` should come from `list_comments`, `file_path` is a LOCAL path requiring user confirmation, `name` is optional and defaults to the basename, and the file rules mirror `create_issue_attachment`. Some repetition of schema text exists, but the added constraints are genuinely helpful.

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 the exact verb/resource (“Upload a local file as an attachment on one issue COMMENT”) and identifies the required `comment_id`, clearly distinguishing it from `create_issue_attachment`, which targets issue attachments instead of comment attachments. The reference to `list_comments` and `create_issue_attachment` further clarifies the operation's scope.

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?

It tells the agent where to get the ID (“get the id from list_comments”) and ties the request format and constraints to `create_issue_attachment`, giving concrete context for use. It lacks an explicit “use X instead when targeting an issue” exclusion, but the naming and scope are clear enough.

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