add_worklog

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

No annotations are provided, so the description carries the full burden. 'Add' implies a mutation, but the description says nothing about required permissions, whether time can be logged on someone else's behalf, validation/duplicate behavior, or reversibility. For a write operation with zero annotation coverage this is a significant gap.

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?

Front-loaded purpose sentence followed by a compact, well-structured Args block; every line carries parameter information. Slightly terse but no wasted prose.

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?

The output schema exists, so return values need not be explained, and all parameters are documented. The missing pieces are the usage/permission context and side-effect disclosure expected of an un-annotated mutation tool.

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%, and the description compensates well: it documents all four parameters with concrete format examples ('KAN-123', '2h 30m', '1d', '4h', ISO timestamp). It stops short of stating accepted time-spent units or what a null comment/started defaults to.

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?

States a specific verb and resource ('Add a worklog entry to an issue'), which an agent can clearly distinguish from siblings like add_comment or transition_issue. However, it never explicitly contrasts itself with those siblings or explains what a worklog entry is in this system.

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?

There is no guidance on when to use this tool versus alternatives (e.g., add_comment for non-time-tracking notes), no prerequisites such as whether the user must be assignee or have worklog permission, and no notes on when-not to use it.

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