Skip to main content
Glama

canvas_list_module_items

Retrieve all items in a specific Canvas LMS module by providing the course and module IDs, enabling efficient management and organization of educational content.

Instructions

List all items in a module

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesID of the course
module_idYesID of the module

Implementation Reference

  • Core handler function implementing the Canvas API call to list module items for a given course and module, including content_details.
    async listModuleItems(courseId: number, moduleId: number): Promise<CanvasModuleItem[]> {
      const response = await this.client.get(`/courses/${courseId}/modules/${moduleId}/items`, {
        params: {
          include: ['content_details']
        }
      });
      return response.data;
    }
  • src/index.ts:481-490 (registration)
    Registration of the canvas_list_module_items tool in the TOOLS array, including name, description, and input schema.
    name: "canvas_list_module_items",
    description: "List all items in a module",
    inputSchema: {
      type: "object",
      properties: {
        course_id: { type: "number", description: "ID of the course" },
        module_id: { type: "number", description: "ID of the module" }
      },
      required: ["course_id", "module_id"]
    }
  • TypeScript interface defining the structure of CanvasModuleItem objects returned by the tool.
    export interface CanvasModuleItem {
      id: number;
      title: string;
      type: CanvasModuleItemType;
      module_id: number;
      position: number;
      indent: number;
      html_url: string;
      url?: string;
      page_url?: string;
      external_url?: string;
      content_id?: number;
      content_details?: CanvasModuleItemContentDetails;
      completion_requirement?: CanvasModuleItemCompletionRequirement;
      published: boolean;
    }
Install Server

Other Tools

Related 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/DMontgomery40/mcp-canvas-lms'

If you have feedback or need assistance with the MCP directory API, please join our Discord server