Github List Milestones

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds the useful behavioral detail that each milestone includes an issue count, which is not obvious from the schema. It does not disclose pagination behavior or that the default state is 'open', but these are partially visible in the schema.

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?

A single sentence that is front-loaded with the action and resource, and adds the distinguishing issue-count detail without any filler. 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?

For a simple read-only list tool with an output schema and readOnlyHint annotation, the description is mostly adequate. However, it does not mention pagination defaults, the state filter, or how the issue count is represented, leaving an agent to infer those from the schema or discover them at runtime.

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 only 40%, with only 'state' and 'per_page' having descriptions. The tool description does not compensate for the undocumented 'repo_owner', 'repo_name', or 'page' parameters, though their names are fairly self-explanatory. The description adds the issue-count context but no parameter-level detail beyond the 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?

The description states a specific verb ('Lists') and resource ('a repository's milestones') and adds a distinguishing detail ('with the count of issues in each'). It is clear enough to differentiate from github_list_releases and github_list_tags, though it does not explicitly name a sibling.

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 for reading milestone data, and the readOnlyHint annotation reinforces that it is a safe read operation. However, it does not explicitly state when to prefer this over alternatives like github_list_open_issues_prs or github_get_issue, nor does it mention pagination or state filtering as usage considerations.

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