Skip to main content
Glama

list_modules

Read-only

List all modules in a Canvas course using course code or ID. Optionally filter modules by search term and include item summaries.

Instructions

List all modules in a course.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
search_termNoFilter modules by name
include_itemsNoInclude summary of items in each module
course_identifierYesCourse code or Canvas ID

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. Changed11 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 / include_items / description
      Added value: +"Include summary of items in each module"
    • removedInput schema / properties / include_items / title
      Removed value: -"Include Items"
    • addedInput schema / properties / search_term / description
      Added value: +"Filter modules by name"
    • removedInput schema / properties / search_term / title
      Removed value: -"Search Term"
    • removedInput schema / title
      Removed value: -"list_modulesArguments"
    • removedOutput schema / properties / result / title
      Removed value: -"Result"
    • removedOutput schema / title
      Removed value: -"list_modulesOutput"
    • addedOutput schema / x-fastmcp-wrap-result
      Added value: +true
  3. Addedv1.3.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint: true, so the tool is safe and non-destructive. The description adds no further behavioral context, but for a simple read-only list operation, that is acceptable. No contradiction exists.

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?

The description is one short, front-loaded sentence that states the primary purpose with no fluff. Every word contributes to the meaning.

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?

The tool is simple, and the annotation and schema cover the essentials. There is no output schema, but for a listing operation the description suffices. It could mention that the result includes module metadata and optionally items, but that is implied by the include_items parameter. It is adequately complete for its complexity.

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 three parameters (course_identifier, search_term, include_items) are documented. The description adds nothing beyond the schema, but the baseline of 3 applies when the schema carries the full burden. It does not clarify that 'search_term' filters by name or that 'include_items' controls item summaries, but those are already in the schema.

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 the action (list) and resource (modules) with a scope (in a course). It distinguishes from siblings like list_module_items (which lists items within modules) and create_module/update_module/delete_module (which are mutations). The purpose is unambiguous.

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 usage: when you need a list of modules for a given course. It does not provide explicit guidance about when not to use it or mention alternatives like list_module_items for module contents. However, given the tool's simplicity and the presence of a clear parameter for course identification, the context is sufficient for basic selection.

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