retrieveWorklogs

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

Discloses default behavior, filter combination as union, and permission constraints leading to silent filtering. With no annotations, the description carries full burden and addresses key behavioral aspects, though pagination or error behavior is not mentioned.

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?

Single paragraph is efficient and front-loaded with the main action. Could be slightly more structured but no redundant information.

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?

Covers essential aspects: purpose, defaults, filters, permissions, and behavioral quirks. Lacks output format description but with no output schema it is 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?

Adds meaning beyond schema by explaining the default behavior and clarifying that 'users' can be multiple identifier types and filters combine as union. Schema coverage is 60%, and the description compensates well for the undocumented parameters.

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?

Clearly states the tool retrieves Tempo worklogs within a date range. Defaults to own worklogs, with optional filters for others. Distinguishes from sibling tools which are for creation, deletion, or editing.

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 explicit context for default vs filtered retrieval and permission requirements. Implicitly differentiates from mutation siblings, but does not explicitly state when not to use or compare to other retrieval tools like getMissingWorklogDays.

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