list_work_logs

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

Annotations already indicate readOnlyHint=true and openWorldHint=true. The description confirms read-only behavior by stating 'List work logs' and adds the return type (list of WorkItemWorkLog objects), which is beyond what annotations provide. No contradictions.

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 well-structured as a Google-style docstring with clear Args and Returns sections. Every sentence is necessary and earns its place, with no extraneous content.

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 tool is a simple list operation with read-only hints and an output schema (implied). The description covers the essential purpose and parameters. It doesn't address pagination, sorting, or permissible query parameters, but given the overall simplicity and annotation support, it is still fairly complete.

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 basic meaning for project_id ('UUID of the project') and work_item_id ('UUID of the work item'), which is not present in the schema (which only specifies type 'string'). However, the params parameter is described as 'Optional query parameters as a dictionary' with no further details, leaving ambiguity about allowed keys or formats. Schema description coverage is 0%, so the description partially compensates.

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 'List work logs for a work item.' which specifies the action (list) and the resource (work logs scoped to a work item). It effectively distinguishes from sibling tools that create, update, or delete work logs, as well as other list tools.

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 names the required parameters (project_id and work_item_id) and mentions optional params, clearly indicating the context needed. It does not explicitly state when not to use this tool or name alternatives, but the sibling list (create_work_log, update_work_log, delete_work_log) provides implicit differentiation.

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