Archive Shortcut Epic

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

With no annotations, the description carries the burden of disclosing behavior. It discloses that both confirm_archive=true and confirm='CONFIRM_WRITE' are required, which is useful safety information. However, it does not explain the side effects of archiving (e.g., reversibility, status changes) or error responses.

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 with no fluff. Every word adds value, and it is front-loaded with the primary purpose followed by the key prerequisite.

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?

This is a mutation tool with no annotations and no output schema. The description is too minimal to be contextually complete: it omits return values, failure modes, dry_run behavior, and any note about whether archiving is reversible. It does not provide enough context for an agent to fully anticipate the tool's behavior.

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 50% (confirm and confirm_archive have descriptions). The description adds the requirement that both must be set together, which is not explicitly stated in the schema. However, it does not clarify the meaning or purpose of dry_run or epic_id beyond the schema, leaving some parameter semantics incomplete.

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 ('Archive a Shortcut epic') with a specific verb and resource. It does not explicitly differentiate from sibling tools like archive_story or delete_epic, but the verb 'archive' is distinct enough to convey the purpose.

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?

No guidance is provided on when to use this tool versus alternatives (e.g., delete_epic for permanent removal, update_epic for edits). The confirmation requirement implies a guarded action, but the description does not explain the appropriate context or scenarios.

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