github_migrations_get_status_for_authenticated_user

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

No annotations are provided, so the description must carry the full behavioral burden. It only says 'Get', implying a read operation, but does not disclose potential side effects, rate limits, error conditions (e.g., migration not found), or any other behavioral traits. This is insufficient.

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 that is front-loaded and contains no unnecessary words. It is as concise as possible while still conveying the basic purpose.

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?

Given the tool's complexity (migration status retrieval) and lack of output schema or annotations, the description is incomplete. It does not explain what a migration status is, possible values, or how to interpret the response. The 'exclude' parameter is undefined. More context is needed for an agent to use it 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?

Schema coverage is 100%, so the baseline is 3. The description adds no additional meaning beyond the parameter names ('migration_id', 'exclude'). It does not explain the required format of migration_id or what exclude excludes (e.g., specific repositories?). No value added beyond schema.

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 tool retrieves a user migration status, with a specific verb and resource. It distinguishes from sibling tools like 'get_status_for_org' by including 'for_authenticated_user'. However, it does not explain what a 'migration' is in this context, which is a minor gap.

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. For example, 'list_for_authenticated_user' could be used first to find a migration ID, and 'get_status_for_org' is for org-level migrations. The description lacks any usage context or exclusions.

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