Get Content Migration

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

Annotations already establish read-only and open-world behavior, so the description adds value by explaining the polling behavior tied to workflow_state. It discloses that progress_url should be polled for live updates and defines what 'completed' means, which is useful beyond the annotations.

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?

Two sentences with no filler. The core purpose is front-loaded, and the conditional polling instruction is concise and directly actionable.

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 status-retrieval tool with readOnlyHint and openWorldHint annotations, the description covers the essential behavior and return-state handling. It does not describe all possible workflow_state values, but it covers the ones needed for correct operation, so it is nearly complete.

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 already provides 100% coverage for both course_id and migration_id with clear descriptions. The tool description adds no additional parameter-level meaning, so the baseline of 3 applies.

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 starts with 'Get the status of a single content migration,' naming a specific verb, resource, and granularity. The word 'single' clearly distinguishes this from list_content_migrations or list_content_exports, so an agent can select the right tool without opening schemas.

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?

It gives actionable context: when workflow_state is 'running', poll progress_url, and when 'completed', the migration is done. It does not explicitly contrast with sibling alternatives, but the context is clear enough for the primary usage pattern.

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