canvas_get_course_grades
Retrieve course grades by providing the course ID, enabling easy access to student performance data within the Canvas Learning Management System.
Instructions
Get grades for a course
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| course_id | Yes | ID of the course |
Implementation Reference
- src/index.ts:389-399 (registration)Registration of the canvas_get_course_grades tool in the TOOLS array, including name, description, and input schema requiring a course_id.
{ name: "canvas_get_course_grades", description: "Get grades for a course", inputSchema: { type: "object", properties: { course_id: { type: "number", description: "ID of the course" } }, required: ["course_id"] } }, - src/index.ts:1352-1360 (handler)Execution handler for canvas_get_course_grades tool within the CallToolRequestSchema switch statement. Extracts course_id from arguments and calls CanvasClient.getCourseGrades().
case "canvas_get_course_grades": { const { course_id } = args as { course_id: number }; if (!course_id) throw new Error("Missing required field: course_id"); const grades = await this.client.getCourseGrades(course_id); return { content: [{ type: "text", text: JSON.stringify(grades, null, 2) }] }; } - src/client.ts:568-577 (handler)Core implementation of getCourseGrades in CanvasClient class. Makes API request to /courses/{courseId}/enrollments?include[]=grades&include[]=observed_users to fetch grades data.
async getCourseGrades(courseId: number): Promise<CanvasEnrollment[]> { const response = await this.client.get(`/courses/${courseId}/enrollments`, { params: { include: ['grades', 'observed_users'] } }); return response.data; } async getUserGrades(): Promise<any> { - src/types.ts:185-218 (schema)Type definitions for CanvasEnrollment (containing grades field) and CanvasGrades interfaces, defining the structure of the output data returned by getCourseGrades.
export interface CanvasEnrollment { readonly id: EnrollmentId; readonly user_id: UserId; readonly course_id: CourseId; readonly type: CanvasEnrollmentType; readonly role: string; readonly enrollment_state: CanvasEnrollmentState; readonly grades?: CanvasGrades; readonly user?: CanvasUser; readonly observed_users?: CanvasUser[]; } export type CanvasEnrollmentType = | 'StudentEnrollment' | 'TeacherEnrollment' | 'TaEnrollment' | 'DesignerEnrollment' | 'ObserverEnrollment'; export type CanvasEnrollmentState = | 'active' | 'invited' | 'inactive' | 'completed' | 'rejected'; export interface CanvasGrades { readonly current_score: number | null; readonly final_score: number | null; readonly current_grade: string | null; readonly final_grade: string | null; readonly override_score?: number | null; readonly override_grade?: string | null; }