Skip to main content
Glama

canvas_list_quizzes

Retrieve a detailed list of quizzes within a specific course using the Canvas LMS API, enabling efficient management and review of course assessments.

Instructions

List all quizzes in a course

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesID of the course

Implementation Reference

  • src/index.ts:572-581 (registration)
    Registration of the 'canvas_list_quizzes' tool in the TOOLS array, including name, description, and input schema requiring a course_id.
      name: "canvas_list_quizzes",
      description: "List all quizzes in a course",
      inputSchema: {
        type: "object",
        properties: {
          course_id: { type: "number", description: "ID of the course" }
        },
        required: ["course_id"]
      }
    },
  • Core handler function in CanvasClient that executes the tool logic by fetching quizzes from the Canvas API endpoint `/courses/{course_id}/quizzes`.
    async listQuizzes(courseId: string): Promise<CanvasQuiz[]> {
      const response = await this.client.get(`/courses/${courseId}/quizzes`);
      return response.data;
    }
  • Input schema for the tool, defining the required course_id parameter of type number.
    inputSchema: {
      type: "object",
      properties: {
        course_id: { type: "number", description: "ID of the course" }
      },
      required: ["course_id"]
  • Type definition for CanvasQuiz, used for output validation and typing of the quizzes returned by the tool.
    export interface CanvasQuiz {
      id: number;
      title: string;
      html_url: string;
      quiz_type: CanvasQuizType;
      assignment_id?: number;
      time_limit: number | null;
      published: boolean;
      description: string | null;
      due_at: string | null;
      lock_at: string | null;
      unlock_at: string | null;
      points_possible: number;
      question_count: number;
      allowed_attempts: number;
      scoring_policy: 'keep_highest' | 'keep_latest';
      show_correct_answers: boolean;
      show_correct_answers_at: string | null;
      hide_correct_answers_at: string | null;
      shuffle_answers: boolean;
      has_access_code: boolean;
      ip_filter?: string;
      locked_for_user: boolean;
      lock_explanation?: string;
    }
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic action without disclosing behavioral traits like pagination, rate limits, authentication needs, or return format. It fails to add meaningful context beyond the minimal purpose, leaving gaps in understanding how the tool behaves.

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 a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is front-loaded and appropriately sized for a simple list operation, with no wasted content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a list tool with no annotations and no output schema, the description is incomplete. It lacks details on behavioral aspects like pagination, filtering, or error handling, and does not clarify the return format or how it differs from sibling tools, leaving significant gaps for an AI agent.

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 fully documents the single parameter 'course_id'. The description does not add any meaning beyond what the schema provides, such as explaining what 'quizzes' entails or how the listing is structured, but this is acceptable given the high schema coverage.

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?

The description clearly states the action ('List') and resource ('quizzes in a course'), making the purpose understandable. However, it does not differentiate from sibling tools like 'canvas_list_assignments' or 'canvas_get_quiz', which could cause confusion about scope or detail level.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives such as 'canvas_get_quiz' for a single quiz or other list tools for different resources. The description lacks context on prerequisites or exclusions, leaving usage decisions ambiguous.

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

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