Skip to main content
Glama

Mark Module Item Read

mark_module_item_read
Idempotent

Marks a Canvas module item as viewed to satisfy its 'must view' requirement without opening it, updating the instructor’s progress view.

Instructions

Mark a module item as viewed to satisfy a 'must view' requirement, without opening it. Shows in your instructor's progress view.

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>",
      "item_id": "<item_id>"
    },
    "name": "mark_module_item_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
item_idYesModule item ID (numeric string). Get it from list_module_items.
course_idYesCanvas course ID, a numeric string such as "12345". Get it from list_courses.
module_idYesModule ID (numeric string). Get it from list_modules.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.0.2
    • changedInput schema / properties / course_id / description
      Previous value: -"Canvas course ID"New value: +"Canvas course ID, a numeric string such as \"12345\". Get it from list_courses."
    • changedInput schema / properties / item_id / description
      Previous value: -"Canvas ID (numeric string)"New value: +"Module item ID (numeric string). Get it from list_module_items."
    • changedInput schema / properties / module_id / description
      Previous value: -"Canvas ID (numeric string)"New value: +"Module ID (numeric string). Get it from list_modules."
  2. First observedv1.0.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare non-read-only, idempotent, non-destructive, and open-world. The description adds meaningful context beyond them: the item is not actually opened, and the action surfaces in the instructor's progress view, which is a consequence an agent should know before calling.

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 compact sentences, effect first and consequence second, with no filler. Every clause carries information.

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?

Three fully documented required parameters, no output schema, and annotations covering the safety profile, so the description is nearly complete. It does not say whether the mark can be undone or whether it fails if the item lacks a must-view requirement, which would be the last useful detail.

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% and each parameter names its source lookup tool, so the schema does the heavy lifting. The description contributes no additional parameter meaning, which is the baseline-3 case.

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

Purpose4/5

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

Specific verb and resource ('mark a module item as viewed') plus the outcome it produces. It stops short of explicitly distinguishing itself from the very close sibling mark_module_item_done, so an agent must infer that 'viewed' differs from 'done'.

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 'must view' requirement gives a clear use condition, which is real guidance. But there is no exclusion or alternative named, and the obvious alternative (mark_module_item_done) is left for the agent to reason about unaided.

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