List Milestones

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

Beyond the readOnlyHint annotation, the description discloses the response shape ({ items, pagination }) and the pagination fields (count, current_page, has_next), as well as the default page_size of 30. This adds useful behavioral context without contradicting the annotations.

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?

Two sentences, front-loaded with the primary purpose, then concise details on response format and default pagination. Every word earns its place without redundancy.

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 list tool with 4 well-documented parameters and no output schema, the description provides the essential purpose, response structure, and pagination behavior. It is sufficiently complete to guide an agent in selecting and invoking the tool correctly, though it could mention edge cases or alternative tool references but not necessary given the complexity.

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 100%, so all four parameters are already documented in the schema. The description only reiterates that filtering is optional and states the default page_size, which is already present in the schema. It adds no significant new meaning beyond the structured definitions.

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 opens with 'List milestones', a specific verb+resource action that clearly distinguishes it from sibling tools like milestone_get, milestone_create, and milestone_stats. The optional filtering phrase adds scope context.

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 indicates the tool is for listing milestones with optional query parameter filtering, giving clear context. It doesn't explicitly mention alternatives like milestone_get for single items, but the list-oriented purpose is evident from the name and description.

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