github_migrations_get_archive_for_authenticated_user

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

With no annotations provided, the description carries the full burden. It only says 'Download', omitting behavioral details like response type (binary stream, URL, redirect), whether the archive is a one-time download, or any side effects. The agent cannot infer usage implications.

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 wasted words, but this brevity leads to missing crucial details. It is concise but sacrifices completeness, making it barely adequate.

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 tool with one parameter and no output schema, the description should explain what a 'user migration archive' is and what the tool returns. It fails to provide this, leaving the agent with insufficient context to use the tool correctly.

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?

There is one parameter, 'migration_id', with schema description simply repeating its name. The tool description adds no extra meaning, leaving the agent to infer that it is a unique identifier. While schema coverage is 100%, the lack of context (e.g., format, source) limits added value.

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 'Download a user migration archive' uses a clear verb and resource, distinguishing it from sibling migration tools like 'get_status' or 'list' by indicating a download action. It aligns with the tool name's 'get_archive' and 'for_authenticated_user' scope, but could be more specific about the archive format or 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 on when to use this tool versus alternatives such as 'github_migrations_download_archive_for_org' or 'github_migrations_get_status_for_authenticated_user'. The description lacks context on prerequisites, required permissions, or typical use cases.

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