set_epic_milestone

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

Beyond the annotation (readOnlyHint=false, indicating a write operation), the description adds the critical behavioral trait that dry_run=true by default, meaning the tool does not actually execute without user confirmation. It also specifies the underlying API (Work Items API). This provides transparency beyond what annotations convey.

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 extremely concise: two sentences, no filler. The first sentence front-loads the primary purpose and API context; the second adds the critical default behavior. Every word is purposeful.

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?

As a mutation tool with no output schema, the description fails to convey the outcome (e.g., success confirmation, error conditions, or effects on the epic/milestone). It also omits constraints like milestone group membership. The default dry_run info helps but does not compensate for missing result and side-effect details.

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 100%, with detailed descriptions for all 4 parameters. The main description adds no parameter-level information beyond stating the default dry_run value, which is already present in the schema. Thus, the description does not enhance parameter understanding.

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 the action 'Associate a milestone with an epic' and includes the API used (Work Items API) and default behavior (dry_run=true). Among many epic-related siblings (e.g., set_epic_health_status, set_epic_iteration), this tool's unique purpose is unmistakable.

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 explicit guidance on when to use this tool versus alternatives, nor does it mention prerequisites or when to avoid it. Although the input schema for group_id hints at using list_groups first, that is not in the main description. The default dry_run=true is stated but not framed as usage advice.

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