Get work log

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

Annotations already declare readOnlyHint=true, which the description confirms with 'Read'. However, the description adds little beyond that—only the velocity rollup return value. It does not disclose any behavioral traits like rate limits, data freshness, or effects of the limit parameter.

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 a single sentence that is front-loaded with the key action and resource. Every word carries meaning, and there is no extraneous information. It is appropriately sized for the information conveyed.

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?

Given the tool's complexity (3 parameters, no output schema, annotations providing readOnlyHint), the description covers the purpose and basic filtering but omits details on the 'limit' and 'project' parameters, pagination, and response format. The velocity rollup mention is helpful but incomplete.

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%, so the description must compensate. It explains that 'ticket' is an optional filter, but 'limit' and 'project' are left unexplained. 'project' is required and not mentioned at all. This is insufficient for a 3-parameter tool with no schema descriptions.

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 'Read', the resource 'work-log entries', the ordering 'most-recent first', optional filtering by ticket, and the return value including a velocity rollup. This distinguishes it from sibling tools like 'log_work' (write) and 'get_work_packet' (different resource).

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?

The description only mentions optional filtering by ticket, but provides no guidance on when to use this tool versus alternatives. It does not specify prerequisites, exclusions, or contexts where this tool is inappropriate. Sibling differentiation is minimal.

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