get_milestone_burndown_events

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

With no annotations, the description must carry behavioral disclosure, and it only says 'Get', which is a read verb. It does not state return format, event contents, pagination behavior, or any endpoint limits, leaving the agent to infer safety and outcomes.

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?

One terse 8-word description with no filler and the core resource is front-loaded. It is concise, though it is arguably under-specified for context-heavy decisions.

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?

No annotations and no output schema, so description needs to supply context. It fails to mention required parameter relationships, pagination defaults, or what 'burndown events' entails, making it incomplete for reliable invocation.

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 covers all four parameters, so baseline is 3. Description adds no additional meaning to parameters, but it does indicate the milestone-specific scope that aligns with milestone_id. It does not explain the relationship between project_id and milestone_id.

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?

States a clear verb-resource pair ('Get burndown events') and scope ('for a specific milestone'), making its intent distinct from general milestone GETs. However, it does not name or contrast sibling tools such as get_milestone or get_milestone_merge_requests, so differentiation is left to the agent.

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 on when to use this tool vs alternatives like get_project_events or list_milestones. There are no prerequisites, exclusions, or hints about required context (e.g., that both project_id and milestone_id are needed) despite zero required parameters.

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