read_milestone

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

With no annotations provided, the description carries the behavioral disclosure burden. It warns that the call is network- and token-expensive and explains pagination via limit/offset. It does not describe return shape or error behavior, but the cost warning is meaningful and goes beyond 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?

The description is compact and well-structured: purpose first, then parameters, then a clear cost warning. Every sentence earns its place, and the warning is front-loaded near the top.

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?

The description covers cost, pagination, and intended use, but with no output schema and no annotations it should do more to clarify the return value and the required identifying parameters. It is adequate for a straightforward read tool, yet leaves noticeable gaps.

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 description explains state, project, limit, and offset semantics, which adds real value beyond the bare schema. However, it leaves the required owner, repo, and milestone_id parameters undocumented, and schema description coverage is 0%, so the agent must infer core identifying fields from names alone.

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 first line, 'Full content of every issue attached to a milestone', uses a specific verb and resource and clearly distinguishes this tool from siblings like list_milestones. An agent can immediately tell this reads issues by milestone rather than listing milestones or projects.

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 gives clear operational guidance: avoid unless asked or necessary, and cap cost with limit/offset. It does not name alternative tools for comparison, so it stops short of a fully explicit when-versus-alternatives statement, but the usage context is clear.

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