list_milestone_work_items

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

With no annotations, the description must disclose behavior. It states 'List', implying a read-only operation, but does not mention whether it returns all work items, supports pagination, or any side effects. The optional 'params' field in the schema suggests configurable query parameters, but the description omits this capability.

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, concise sentence with no unnecessary words. It is front-loaded with the action, but it is perhaps too brief for a tool with optional parameters; nonetheless, it avoids verbosity.

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 that an output schema exists (defining return structure), the description is mostly complete for a simple listing. However, it does not hint at the optional 'params' parameter's purpose (e.g., filtering, sorting) or any limitations, which the schema alone conveys.

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 coverage is 100%, so the schema already describes each parameter (e.g., 'UUID of the project'). The description adds no additional meaning beyond the schema, resulting in a baseline score of 3 as per guidelines.

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 'List work items in a milestone' clearly states the action (list) and the resource (work items filtered by milestone). It is specific enough to distinguish from siblings like 'list_cycle_work_items' or 'list_work_items', though it could be more precise by noting the return is a list.

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 like 'list_work_items' (which lists all work items without filtering) or 'list_cycle_work_items'. There is no mention of prerequisites (e.g., the user must have a valid milestone ID) or context about typical use cases.

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