get_milestone

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

Since no annotations are provided, the description carries full burden. It describes returned data (progress counts, description, state, due_on) but does not explicitly state that the operation is read-only or safe. For a fetch tool, it's adequate but could be more transparent about side effects or permissions.

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?

Single well-structured sentence followed by a list of returned fields. No wasted words; essential information is front-loaded.

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 get tool with three parameters and no output schema, the description sufficiently covers purpose, parameter nuance (id vs title), and return values. Could mention that it's read-only for completeness, but not strictly necessary.

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 coverage is 100% with descriptions for all three parameters. The description adds critical context: the id is from list_milestones and not the title. It also lists returned fields, complementing the schema. However, it does not elaborate on repo and owner defaults beyond what schema says.

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 clearly states 'Fetch one milestone by `id`', specifies the id is internal from list_milestones not title, and lists returned fields. Distinguishes from list_milestones effectively.

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?

Explicitly says to use the internal id from list_milestones and warns not to use title. Provides clear context for when to use this tool, though does not explicitly exclude alternative tools or mention when not to use.

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