comment_on_task

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

Discloses identity ('authored as the connected member'), visibility ('visible to the whole org'), and return value ('return the created comment'). Without annotations, the description carries the burden well, but could mention error handling or permissions.

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 concise sentences, front-loaded with purpose, use case, and prerequisite. No unnecessary words.

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 simple tool (2 required params, no output schema), the description covers purpose, usage, behavior, and parameters adequately. Lacks error details, but acceptable.

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% with descriptions. The description adds value by reinforcing that both parameters are required and giving context for the id ('resolve task id first').

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', the resource 'comment to a task', and the outcome 'return the created comment'. It distinguishes from siblings like 'add_note' and 'create_task' by specifying the action on a task 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?

Provides clear use cases ('record progress, a decision, or a handoff') and prerequisite ('resolve the task id first with list_tasks or get_task'). Lacks explicit guidance on when not to use or contrast with siblings, but the context is sufficient.

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