get_issue_worklogs

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It says 'Get all worklogs' but does not mention whether the operation is read-only (implied by 'get'), whether results are paginated/ordered, or what happens if no worklogs exist. The lack of any behavioral traits beyond the basic function is insufficient for complete transparency.

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 concise and front-loaded: a single purpose statement followed by clear parameter definitions. Every sentence earns its place, and there is no redundant or filler content. The structure is clean and easily scannable.

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 presence of an output schema covers return-value details, and the parameter semantics are well explained. However, the description lacks usage guidelines for distinguishing from sibling worklog tools, and offers no contextual caveats (e.g., pagination, ordering, permissions). It is adequate for a basic getter but not fully complete given the surrounding tool cluster.

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?

The description adds significant meaning beyond the input schema. The schema only provides field names and titles ('Issue Id', 'Project Id'), while the description explicitly explains that project_id is 'The UUID identifier of the project containing the issue' and issue_id is 'The UUID identifier of the issue to get worklogs for'. This fully compensates for the 0% schema description coverage.

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 'Get all worklogs for a specific issue', using a specific verb ('Get'), resource ('worklogs'), and scope ('specific issue'). This distinguishes it from sibling tools like 'get_total_worklogs' which aggregates totals, and 'create_worklog' which writes, making the purpose unmistakable.

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 'get_total_worklogs' or 'create_worklog'. The description does not mention any prerequisites, exclusions, or alternative tools, leaving the user to infer usage from the name alone.

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