Skip to main content
Glama

List Module Items

list_module_items
Read-onlyIdempotent

Lists items in a Canvas module—assignments, pages, files, quizzes, and links—with each completion requirement and whether you met it. Read-only; use list_modules to find module IDs.

Instructions

List the items in a module (assignments, pages, files, quizzes, links) with each one's completion requirement and whether you met it. Read-only. Use list_modules to find module IDs.

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

Input Schema

NameRequiredDescriptionDefault
pageNoWhich page of results to show, starting at 1. Use it when a result says there are more.
limitNoMaximum number of items to return (one page of results). Smaller is faster.
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. Changed2 schema fields changedv1.2.0
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of items to return. Smaller is faster."New value: +"Maximum number of items to return (one page of results). Smaller is faster."
    • addedInput schema / properties / page
      Added value: +{
      +  "description": "Which page of results to show, starting at 1. Use it when a result says there are more.",
      +  "exclusiveMinimum": 0,
      +  "maximum": 9007199254740991,
      +  "type": "integer"
      +}
  2. 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 / limit / description
      Previous value: -"Max items to return"New value: +"Maximum number of items to return. Smaller is faster."
    • changedInput schema / properties / module_id / description
      Previous value: -"Canvas ID (numeric string)"New value: +"Module ID (numeric string). Get it from list_modules."
  3. First observedv1.0.1

TDQS

A4.2/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds useful behavioral context by explaining what data is returned per item, including completion requirements and whether they were met; 'Read-only' is redundant but consistent.

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 with no filler. The primary purpose and return content are front-loaded, followed immediately by the prerequisite for obtaining module IDs.

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?

For a paginated list tool with no output schema, the description tells the agent what will be returned and how to obtain the required module_id. Pagination behavior is left to the schema's page and limit descriptions, which is reasonable.

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 the schema already explains course_id, module_id, page, and limit. The description reinforces that module IDs come from list_modules but does not add syntax or usage detail beyond 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 uses a specific verb and resource ('List the items in a module') and enumerates the item types covered (assignments, pages, files, quizzes, links). It also clarifies that each item includes its completion requirement and the caller's status, which distinguishes it from list_modules and get_module_item.

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?

It explicitly tells the agent to use list_modules first to obtain module IDs, giving clear prerequisite guidance. It does not name an alternative for fetching a single item instead of a full list, but the context is sufficient for normal selection.

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