list_milestones

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

The annotation readOnlyHint=true already covers the safety profile, so the description does not need to reiterate that it is read-only. The description adds the qualifier 'all', indicating that no filtering is applied, which is a slight behavioral context. However, it does not disclose other behavioral traits such as pagination, ordering, or whether completed milestones are included. The description is consistent with the annotation, and there is no contradiction.

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 two sentences: one for the purpose and one for the argument. It is extremely concise, front-loaded with the core action, and contains no fluff or repetition. Every word earns its place.

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 the tool is a simple read-only list with a single parameter and an output schema, the description is nearly sufficient. It clearly identifies the resource and scope, and the output schema is present to define the return value. It does not mention edge cases like empty projects or error conditions, but for a straightforward list operation, this is acceptably 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 input schema has one parameter, project_id, with type integer and no description (0% coverage). The description adds 'The numeric project ID', which clarifies the meaning slightly but mostly restates the type. For a simple single parameter, this is adequate but not rich. It compensates for the missing schema description, so a baseline of 3 is appropriate.

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 all milestones for a project' clearly states the action (list) and the resource (milestones) with a specific scope (for a project). It is distinct from sibling tools like list_projects and list_todo_items, and there is no ambiguity about what this tool does.

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 usage: you need a project_id to list milestones for that project. However, it does not explicitly state when to use this tool versus alternatives, nor does it mention exclusions. There are no sibling tools for listing milestones, so the lack of explicit alternatives is not a major gap, but the guidance is minimal.

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