Skip to main content
Glama

List Canvas modules

canvas_modules
Read-onlyIdempotent

Shows how a Canvas course is organized by modules and units, listing pages, files, assignments, quizzes, and links so you can locate where something lives. Read-only.

Instructions

How a Canvas class is organised: its modules (weeks or units) and what's in each (pages, files, assignments, quizzes, links). Use it to find where something lives. Read-only.

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": "<course>"
    },
    "name": "canvas_modules"
  }
}

Input Schema

NameRequiredDescriptionDefault
courseYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the trailing "Read-only." mainly repeats structured data. The description does add useful shape about what the result contains (modules and their constituent items), which helps an agent plan downstream calls. It says nothing about pagination, course permissions, or truncation for large courses, so the behavioral gain is modest.

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

Conciseness4/5

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

Three short sentences, front-loaded with the substantive content model before the usage hint. The final "Read-only." is largely redundant with readOnlyHint, but it is a single word and costs little.

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?

An output schema exists, so return structure needn't be described, and the description adequately conveys the module/contents hierarchy. The gap is the required `course` argument, whose expected format is undefined anywhere in the definition. For a simple one-parameter read tool that is a real but narrow shortfall.

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

Parameters2/5

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

Schema description coverage is 0% for the single required parameter `course`, and the description never mentions it — it only says "a Canvas class." It gives no indication of whether `course` is an ID, a course code, or a display name, so the description fails to compensate for the coverage gap on the one input an agent must supply.

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?

States a specific resource and scope: the modules (weeks/units) of a Canvas course plus their contents (pages, files, assignments, quizzes, links). This distinguishes it from the single-item siblings like canvas_page or canvas_assignment, which fetch individual objects rather than the structural outline. It does not explicitly name a sibling it supersedes, keeping it just below the top mark.

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?

"Use it to find where something lives" gives a clear when-to-use context: orientation/browsing when the location of content is unknown. There is no explicit when-not clause and no named alternative (e.g. canvas_search for lookup by name), so routing between discovery tools is left partly to inference.

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