Canvas MCP Server V2.0

Instructions

Implementation Reference

• src/client.ts:702-705 (handler)

  Executes the core logic to fetch detailed information about a specific quiz from the Canvas API using the provided course ID and quiz ID.

  async getQuiz(courseId: string, quizId: number): Promise<CanvasQuiz> {
    const response = await this.client.get(`/courses/${courseId}/quizzes/${quizId}`);
    return response.data;
  }

• src/index.ts:583-593 (registration)

  Registers the canvas_get_quiz tool in the MCP server's TOOLS array, providing its name, description, and input schema for validation.

    name: "canvas_get_quiz",
    description: "Get details of a specific quiz",
    inputSchema: {
      type: "object",
      properties: {
        course_id: { type: "number", description: "ID of the course" },
        quiz_id: { type: "number", description: "ID of the quiz" }
      },
      required: ["course_id", "quiz_id"]
    }
  },

• src/types.ts:292-316 (schema)

  Defines the TypeScript interface for the CanvasQuiz object, specifying the expected output structure and types for the tool response.

  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;
  }