Skip to main content
Glama

Create Content Export

create_content_export
Destructive

Start a Canvas course content export as Common Cartridge, QTI, or zip. Receive an export ID immediately, then poll get_content_export to retrieve the download link.

Instructions

Start a Canvas course content export (Common Cartridge / QTI / zip). Exports are asynchronous — this tool returns immediately with an export ID and initial workflow_state ("created"). Call get_content_export to poll progress and retrieve the time-limited download link when the export finishes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesThe Canvas course ID
export_typeYesExport format: common_cartridge (IMS CC, widely portable for migration/backup), qti (assessments only), zip (Canvas-native files archive)

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
  2. Addedv1.18.3

TDQS

A4.6/5.0
Behavior4/5

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

The description discloses the asynchronous behavior: returns immediately with an export ID and initial workflow_state ('created'), and that the download link is time-limited. This adds meaningful context beyond the annotations. However, annotations include destructiveHint=true, and the description doesn't explicitly warn about resource consumption or cleanup, though it does note the async nature. No contradiction with annotations.

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?

Three sentences, each earning its place: what it does, the async behavior, and the next step. Front-loaded with the core purpose, then critical behavioral detail, then routing guidance. No fluff.

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?

For a 2-parameter tool with full schema coverage and no output schema, the description covers the essential workflow: initiation, polling, and download link retrieval. It doesn't mention error cases or permission requirements, but the async flow and next-step routing are sufficient for an agent to call it correctly. The destructiveHint annotation is present but the description doesn't elaborate on what 'destructive' means here, which is a minor gap.

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

Parameters4/5

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

Schema coverage is 100%, so the schema already documents both parameters. The description adds value by explaining the export_type enum values in plain language (common_cartridge for migration/backup, qti for assessments only, zip for Canvas-native files archive), which helps an agent choose correctly. This goes beyond the schema's terse descriptions.

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?

The description states a specific verb ('Start'), a resource ('Canvas course content export'), and the formats (Common Cartridge / QTI / zip). It clearly distinguishes this from related tools like get_content_export and list_content_exports by naming the asynchronous initiation role.

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

Usage Guidelines5/5

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

The description explicitly tells the agent to call get_content_export to poll progress and retrieve the download link, which is a clear when-to-use/next-step instruction. It also implies this tool is for starting exports, not checking them, which differentiates it from sibling tools.

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