list_milestones

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

Annotations already mark the tool readOnly, and the word 'List' is consistent with that. The description contributes the filter behavior of state (open/closed/all), but doesn't disclose default state or pagination behavior. Since the safety profile is covered by annotations, this is adequate but not rich.

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 short, front-loaded sentence with no filler. The key parameter values are neatly formatted in backticks and each word adds information.

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 read-only listing endpoint with an output schema and readOnlyHint, the description is minimally sufficient: owner/repo are obvious, and state values are given. However, it omits pagination semantics and the default state, and the bare schema doesn't fill that gap. It is viable but leaves room for misinterpretation.

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%, so the description carries the burden for parameter meaning. It clarifies state values and implies owner/repo via 'repository', but leaves page, limit, and the default behavior of state unexplained. This is only partial compensation for an undocumented schema.

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?

Description names a specific verb ('List'), resource ('milestones'), and scope ('in a repository'), and adds the valid state values. It doesn't explicitly distinguish from sibling tools such as create_milestone or list_labels, but the resource and verb make the basic purpose unambiguous.

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 versus alternatives like list_issues or create_milestone, and no exclusions are stated. The only contextual hint is the 'repository' scope, so an agent must infer selection from the tool name.

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