Skip to main content
Glama

update_module

DestructiveIdempotent

Modify an existing Canvas module's settings by renaming it, changing its position, managing prerequisites, and updating publish or unlock status.

Instructions

Update an existing module's settings.

Input Schema

TableJSON 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. Dates show when Glama detected each change.

  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

A3.5/5.0
Behavior2/5

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

The annotations already provide idempotentHint=true and destructiveHint=true, covering the safety profile. The description adds nothing beyond the bare 'update' — it does not clarify partial vs full updates, whether missing optional fields retain prior values, or any other behavioral nuances. Since annotations carry the burden, the description's minimal additional context yields a low-but-not-contradictory score.

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?

One concise sentence, no filler. It is front-loaded and effectively sized for the tool's simplicity. Every word earns its place.

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

Completeness3/5

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

Given the tool's straightforward nature, the description plus rich schema and annotations are sufficient for basic use. However, it omits details like partial update semantics (whether unspecified fields are untouched) and error scenarios, which would be valuable for an update mutation. It is adequate but not thorough.

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%, with each parameter having a clear description (e.g., 'New module name'). The tool description itself does not add any param detail, but the schema fully documents meaning. Baseline 3 is appropriate.

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 clearly states 'Update an existing module's settings' — a specific verb and resource that distinguishes it from sibling tools like create_module and delete_module. No ambiguity about what this tool does.

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

Usage Guidelines3/5

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

The description implies this is for modifying an existing module, but offers no explicit guidance on when to choose this over create_module or delete_module, nor any prerequisites beyond the required parameters visible in the schema. It is adequate but not prescriptive.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vishalsachdev/canvas-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server