Skip to main content
Glama
Sign In
vishalsachdev

Canvas MCP Server

by vishalsachdev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Update Module

update_module
DestructiveIdempotent

Update an existing Canvas module's settings including name, position, publish status, unlock date, prerequisites, and sequential progress rules.

Instructions

Update an existing module's settings.

Input Schema

NameRequiredDescriptionDefault
nameNoNew module name
positionNoNew position in module list
module_idYesModule ID to update
publishedNoWhether the module is published
unlock_atNoNew unlock date/time (ISO 8601), or empty string to remove
course_identifierYesCourse code or Canvas ID
prerequisite_module_idsNoComma-separated prerequisite module IDs, or empty to clear
require_sequential_progressNoStudents must complete items in order

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.10.0
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "type": "string"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "type": "object",
-  "x-fastmcp-wrap-result": true
-}New value: +null
  2. Changed21 schema fields changedv1.8.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / course_identifier / description
      Added value: +"Course code or Canvas ID"
    • removedInput schema / properties / course_identifier / title
      Removed value: -"Course Identifier"
    • addedInput schema / properties / module_id / description
      Added value: +"Module ID to update"
    • removedInput schema / properties / module_id / title
      Removed value: -"Module Id"
    • addedInput schema / properties / name / description
      Added value: +"New module name"
    • removedInput schema / properties / name / title
      Removed value: -"Name"
    • addedInput schema / properties / position / description
      Added value: +"New position in module list"
    • removedInput schema / properties / position / title
      Removed value: -"Position"
    • addedInput schema / properties / prerequisite_module_ids / description
      Added value: +"Comma-separated prerequisite module IDs, or empty to clear"
    • removedInput schema / properties / prerequisite_module_ids / title
      Removed value: -"Prerequisite Module Ids"
    • addedInput schema / properties / published / description
      Added value: +"Whether the module is published"
    • removedInput schema / properties / published / title
      Removed value: -"Published"
    • addedInput schema / properties / require_sequential_progress / description
      Added value: +"Students must complete items in order"
    • removedInput schema / properties / require_sequential_progress / title
      Removed value: -"Require Sequential Progress"
    • addedInput schema / properties / unlock_at / description
      Added value: +"New unlock date/time (ISO 8601), or empty string to remove"
    • removedInput schema / properties / unlock_at / title
      Removed value: -"Unlock At"
    • removedInput schema / title
      Removed value: -"update_moduleArguments"
    • removedOutput schema / properties / result / title
      Removed value: -"Result"
    • removedOutput schema / title
      Removed value: -"update_moduleOutput"
    • addedOutput schema / x-fastmcp-wrap-result
      Added value: +true
  3. Addedv1.3.0

TDQS

C2.5/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true and idempotentHint=true. The description adds no further behavioral context, such as which settings are destructive to change, what happens to omitted fields, or whether changes are reversible.

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

Conciseness3/5

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

A single sentence with no wasted words, but it is under-specified rather than concisely informative, so it earns only a minimal score.

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

Completeness2/5

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

For an eight-parameter mutation tool with destructive annotations and no output schema, the description should do more to explain side effects, field behavior, and scope. The current sentence leaves significant gaps.

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 all eight parameters are documented in the schema. The description adds no parameter-level meaning beyond what the schema already provides, so baseline 3 is appropriate.

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

Purpose3/5

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

States a specific verb and resource ("Update an existing module's settings"), but "settings" is vague and the description does not distinguish this tool from siblings such as update_module_item or update_assignment.

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

Usage Guidelines2/5

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

Provides no guidance on when to use this tool versus alternatives like update_module_item or create_module, and no prerequisites or exclusions are mentioned.

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