Skip to main content
Glama

Create Content Migration

create_content_migration
Destructive

Start a content migration (course copy, Common Cartridge import, zip import, QTI conversion, or Moodle conversion). Migrations are asynchronous — this tool returns immediately with a migration ID and progress_url.

Instructions

Start a content migration (course copy, Common Cartridge import, zip import, QTI conversion, or Moodle conversion). Migrations are asynchronous — this tool returns immediately with a migration ID and progress_url. Poll get_content_migration or progress_url to track completion.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
settingsNoMigration-type-specific settings. For course_copy_importer, pass { source_course_id: <id> }.
course_idYesThe destination Canvas course ID
migration_typeYesThe type of migration to run
selective_importNoIf true, migration enters "waiting_for_select" state so you can choose which content to import via get_migration_selective_data.
date_shift_optionsNoOptions for shifting dates during the migration (e.g. { shift_dates: true, old_start_date: "...", new_start_date: "..." }).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.18.15
    • addedInput schema / properties / course_id / anyOf
      Added value: +[
      +  {
      +    "exclusiveMinimum": 0,
      +    "maximum": 9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "pattern": "^[1-9][0-9]{0,18}$",
      +    "type": "string"
      +  }
      +]
    • removedInput schema / properties / course_id / type
      Removed value: -"number"
  2. Changed1 schema field changedv1.18.11
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Addedv1.18.4

TDQS

A4.2/5.0
Behavior4/5

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

Annotations declare destructiveHint=true and openWorldHint=true, and the description usefully adds that the call is asynchronous, returns immediately, and yields a migration ID plus progress_url. It stops short of warning that a migration can overwrite/replace existing course content (the destructiveHint implication) or noting any permission prerequisites, which would be the higher-value additions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, zero filler: the first names the operation and its variants, the second covers the async contract and the polling path. Front-loaded with the action, and every clause earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description correctly compensates by describing the immediate return (migration ID, progress_url) and the polling workflow. It lacks any note on permissions or irreversible content replacement, so a complex, destructive, nested-object tool is not fully covered.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description restates the migration types already enumerated in the migration_type enum and does not add syntax or format detail for settings, selective_import, or date_shift_options beyond what the schema documents.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Start a content migration') and enumerates the five concrete migration types (course copy, Common Cartridge, zip, QTI, Moodle), which maps directly to the migration_type enum. An agent can distinguish this from siblings like create_content_export or list_content_migration_types without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tells the agent what to do after invocation — poll get_content_migration or progress_url — which is explicit follow-up guidance. However, it never contrasts this tool with adjacent siblings such as create_content_export (export vs. import) or list_content_migration_types (to discover valid types), leaving that selection to inference.

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

Deploy Server

Other Tools