list_modulesRetrieves all modules in a Canvas course by course code or ID, with optional name filtering and item summaries.
List all modules in a course.
| Name | Required | Description | Default |
|---|---|---|---|
| search_term | No | Filter modules by name | |
| include_items | No | Include summary of items in each module | |
| course_identifier | Yes | Course code or Canvas ID |
Changes observed during successful MCP inspections.
v1.10.0Output schema / (root)Previous value: -{
- "properties": {
- "result": {
- "type": "string"
- }
- },
- "required": [
- "result"
- ],
- "type": "object",
- "x-fastmcp-wrap-result": true
-}New value: +nullv1.8.0Input schema / additionalPropertiesAdded value: +falseInput schema / properties / course_identifier / descriptionAdded value: +"Course code or Canvas ID"Input schema / properties / course_identifier / titleRemoved value: -"Course Identifier"Input schema / properties / include_items / descriptionAdded value: +"Include summary of items in each module"Input schema / properties / include_items / titleRemoved value: -"Include Items"Input schema / properties / search_term / descriptionAdded value: +"Filter modules by name"Input schema / properties / search_term / titleRemoved value: -"Search Term"Input schema / titleRemoved value: -"list_modulesArguments"Output schema / properties / result / titleRemoved value: -"Result"Output schema / titleRemoved value: -"list_modulesOutput"Output schema / x-fastmcp-wrap-resultAdded value: +truev1.3.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
readOnlyHint=true already tells the agent this is a safe read. The description adds nothing beyond that — no mention that results are scoped to a single course, whether filtering applies, or what include_items does behaviorally. It largely restates what the annotations and schema already convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with zero waste. It is arguably too thin for a tool with a filtering and item-inclusion option, but it is not padded or rambling.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only list tool with full schema coverage and annotations covering the safety profile, the minimum is met. Still missing: any hint of ordering/pagination and a pointer to list_module_items for follow-up, which the agent would want.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents search_term, include_items, and course_identifier. The description says nothing about the parameters beyond the implicit course scoping, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('List') and resource ('modules') scoped to a course, which is clearer than the title alone. It does not, however, distinguish itself from sibling list_module_items, which an agent could easily confuse with it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no when-to-use guidance, no prerequisites (e.g. needing a course ID), and never mentions the obvious alternative list_module_items for drilling into a module's contents. Usage must be inferred entirely from the name and schema.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.