get_milestone_metrics

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

With no annotations, the description carries the full burden of behavioral disclosure. The verb 'Get' implies a read-only operation, but the description does not mention side effects, return format, permission requirements, or any other behavioral detail. It is minimal and leaves many assumptions unstated.

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, front-loaded sentence with no filler. It conveys the tool's purpose efficiently and wastes no words.

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 metric-reading tool with two integer parameters and no output schema, the description provides the metric categories (burndown/completion) but lacks details about return structure, error cases, or authentication. It is minimally viable but leaves gaps an agent must infer.

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%, and the description does not explain the parameters. While project_id and milestone_id are somewhat self-explanatory, the description adds no semantic detail about how to obtain them, their relationship, or any constraints beyond the schema's integer type and required flags.

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 uses a specific verb ('Get') and resource ('milestone's metrics'), with parenthetical scope ('burndown / completion') that clarifies what kind of metrics. This clearly differentiates it from sibling metric tools like get_project_metrics, get_board_metrics, and get_design_element_metrics.

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 implies when to use it (whenever milestone-level burndown or completion metrics are needed) but does not explicitly contrast with sibling metric tools or state when not to use it. No alternatives or exclusions are mentioned.

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