gitee_get_milestone

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

No annotations are provided, so the description must carry the full burden. It only states 'Get a single milestone', which indicates a read operation. Missing details include whether errors occur for nonexistent milestones, required permissions, or the structure of the returned data.

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 a single sentence of four words, which is minimal but not wasteful. It is front-loaded and concise, but lacks sufficient detail for a tool with multiple required parameters and no output schema.

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 complexity of the tool (three required parameters, no output schema, and sibling tools for related operations), the description is incomplete. It does not contextualize the use case (e.g., retrieve a milestone by its number) or clarify that the owner and repo identify the repository.

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 100% coverage with clear descriptions for all three parameters (owner, repo, number). The description adds no additional semantic value beyond what the schema already provides, so it meets the baseline of 3.

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 clearly states 'Get a single milestone', which specifies the action (Get) and the resource (milestone). It implicitly differentiates from sibling tools like list_milestones (plural) and create/update/delete tools, though explicit sibling differentiation is absent.

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 provides no guidance on when to use this tool versus alternatives. For instance, it does not mention that this tool is suitable when a specific milestone number is known, while list_milestones would be used to retrieve multiple milestones.

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