github_migrations_cancel_import

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

No annotations exist, and the description does not disclose any behavioral traits. It does not state side effects, prerequisites (e.g., import must be in progress), idempotency, or what happens upon cancellation. The description carries zero behavioral context beyond the action name.

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 short (three words) but this is under-specification, not conciseness. It lacks structure, does not front-load key information, and omits critical details that would fit in minimal space.

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?

With no output schema, no annotations, and only a three-word description, the tool is severely incomplete. The agent lacks necessary context to invoke it correctly, such as the import's required state, potential errors, or return 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?

The input schema describes parameters 'owner' and 'repo' with trivial descriptions ('owner', 'repo'), and the description adds no additional meaning. Though schema coverage is 100%, the description does not clarify their role in the context of cancelling an import.

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 'Cancel an import' identifies the action and resource, but 'import' is vague without context. It is not a tautology, but it fails to distinguish from related migration tools like 'update_import' or 'delete_archive'. The purpose is adequate but lacks specificity.

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 usage guidelines are provided. There is no indication of when to use this tool versus alternatives such as github_migrations_update_import or github_migrations_start_import. The agent receives no guidance on context or exclusions.

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