Add Comment

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

The description discloses that 'dryRun defaults true' but does not explain what dryRun does or any other behavioral aspects like whether the comment is appended or if there are side effects; with no annotations, this is insufficient.

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 very concise (7 words) but at the expense of completeness; it conveys the basic action but lacks necessary detail.

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 3-parameter tool with no output schema, the description is incomplete; it does not explain expected behavior, return values, or prerequisites for adding a comment.

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 0% schema description coverage, the description only mentions 'dryRun defaults true' and does not explain 'note' or 'findingId', adding negligible meaning beyond the schema structure.

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 the verb 'Add' and the resource 'comment' to a 'finding', which is specific and distinct from sibling tools like 'armorcode_add_exploitability_comment'.

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?

No guidance is provided on when to use this tool versus alternatives such as 'armorcode_add_exploitability_comment' or other finding actions; the description only mentions a default value.

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