Skip to main content
Glama

Delete Module

delete_module
DestructiveIdempotent

Permanently delete a module from a course, including its ordered list of module items. Assignments, pages, quizzes, files and discussions that the items link to are stored separately in the course and this call does not delete them, but…

Instructions

Permanently delete a module from a course, including its ordered list of module items. Assignments, pages, quizzes, files and discussions that the items link to are stored separately in the course and this call does not delete them, but ExternalUrl, ExternalTool and SubHeader items exist only inside the module and go with it. There is no single inverse: rebuilding the module means create_module plus create_module_item for each item.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "course_id": "<course_id>",
      "module_id": "<module_id>"
    },
    "name": "delete_module"
  }
}

Input Schema

NameRequiredDescriptionDefault
course_idYesThe Canvas course ID
module_idYesThe Canvas module ID to delete

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.18.19

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the description's job is to add specifics — and it does: it names the exact object graph that is destroyed versus preserved, and warns there is no single inverse. That is precisely the context annotations cannot convey.

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 front-loaded and load-bearing: the action, the deletion boundary, and the recovery cost. No filler or restatement of the name.

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

Completeness5/5

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

For a two-param destructive tool with no output schema, the description covers everything an agent needs: what is deleted, what is not, and how costly reversal is. Nothing relevant is missing.

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?

Both parameters (course_id, module_id) are fully documented in the schema at 100% coverage, so the baseline of 3 applies. The description adds no syntax or formatting detail beyond the schema, nor any guidance on resolving IDs.

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 ("Permanently delete a module from a course") plus the exact scope ("including its ordered list of module items"), which cleanly separates it from the sibling delete_module_item that removes a single item. An agent can pick the right tool 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?

The description sets clear boundaries by enumerating what survives (assignments, pages, quizzes, files, discussions) and what dies (ExternalUrl, ExternalTool, SubHeader items), which is effectively when-this-is-safe guidance. It stops short of explicitly naming delete_module_item or update_module as the alternatives for narrower operations.

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