comment_bug

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

Discloses that solutionModules is required and auto-formatted, and that the comment field is ignored. No annotations provided, so description carries full burden; lacks info on whether comment appends or replaces.

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?

Two concise sentences plus a list, bolded key terms. Every sentence adds value; no redundancy.

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 tool with nested object and no output schema, description explains auto-formatting template. Missing explicit return value, but sufficient for typical usage.

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 description adds significant meaning: clarifies 'comment' is ignored, explains solutionModules fields with good/bad examples, and specifies rejection behavior.

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?

Description clearly states 'Add comment to one bug by ID', specifying verb, resource, and key requirement (solutionModules). Distinguishes from siblings like resolve_bug and close_bug.

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?

Explicitly states that plain comment without solutionModules is rejected and that 'comment' parameter is ignored. Provides clear when-to-use context, though no direct sibling comparison.

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