list_work_logs

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 only states that the tool returns a list of WorkItemWorkLog objects; it does not mention whether the operation is read-only, whether authentication is required, if pagination applies, or any error conditions. This is insufficient for a tool with zero annotation support.

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 with clear Args and Returns sections. Every sentence earns its place, and there is no redundant or irrelevant content. It is appropriately sized for a simple list tool.

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?

For a simple list operation, the description covers the basics: what it lists, required parameters, and return type. However, it lacks details on filtering via params, potential empty results, or authorization needs. Given the output schema exists and the tool is straightforward, this is adequate but not 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 schema has zero description coverage, so the description is the only source of parameter meaning. It correctly identifies project_id and work_item_id as UUIDs and notes that params is an optional dictionary. However, it does not enumerate what query parameters are accepted or provide any examples, leaving the semantics of 'params' vague.

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 tool's function: 'List work logs for a work item.' This specifies the verb (list), resource (work logs), and scope (for a work item), distinguishing it from siblings like get_project_worklog_summary or create_work_log. The name and description align perfectly.

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_project_worklog_summary or list_work_items. There are no exclusions, prerequisites beyond the required IDs, or hints about when this is the appropriate choice. The description only implies usage by naming the required parameters.

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