List Milestones

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

Annotations already declare the tool as read-only and idempotent, but the description adds no behavioral context (e.g., pagination, sorting, default state, what constitutes a milestone). The description does not contradict 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?

At one sentence, the description is terse but lacks structure. It front-loads the basic purpose but omits essential details, making it under-specified rather than efficiently concise.

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 10 parameters, no schema descriptions, no output schema, and the existence of related sibling tools, the description is severely incomplete. It does not explain output format, pagination, or parameter usage.

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 provides no explanation of the 10 optional parameters (iids, page, state, title, search, per_page, project_id, updated_after, updated_before, include_ancestors). The agent must rely solely on parameter names, which may be ambiguous (e.g., 'iids').

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 'List project milestones' clearly states verb and resource, but does not differentiate from sibling tools like gitlab_get_milestone or gitlab_get_milestone_issue. Although the name implies a list operation, the description lacks explicit distinction.

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 such as gitlab_get_milestone, gitlab_get_milestone_issues, or gitlab_list_issues. No prerequisites or context for filtering via parameters.

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