canvas-lms-mcp 1.2.2 → 1.3.0

package/README.md

@@ -10,7 +10,7 @@
 
 MCP server for [Canvas LMS](https://www.instructure.com/canvas). Read courses, assignments, submissions, rubrics, quizzes; grade, comment, manage course content, and handle Canvas admin workflows from any AI agent.
 
-88 tools across Canvas courses, assignments, submissions, rubrics, quizzes, files, users, groups, enrollments, discussions, modules, pages, calendar, conversations, peer reviews, accounts, analytics, student workflows, dashboard, and health checks. Three deployment modes: stdio, HTTP, and library import.
+100 tools across Canvas courses, assignments, submissions, rubrics, quizzes, files, users, groups, enrollments, discussions, modules, pages, calendar, conversations, peer reviews, accounts, analytics, outcomes, student workflows, dashboard, and health checks. Three deployment modes: stdio, HTTP, and library import.
 
 ## Comparison
 
@@ -173,7 +173,7 @@ Once configured, try these prompts with your AI client:
 
 ## Tool Inventory
 
-### All Registered Tools (88)
+### All Registered Tools (100)
 
 | Category | Tools |
 |----------|-------|
@@ -195,10 +195,11 @@ Once configured, try these prompts with your AI client:
 | Peer Reviews | `list_peer_reviews`, `get_submission_peer_reviews`, `create_peer_review`, `delete_peer_review` |
 | Accounts | `get_account`, `list_accounts`, `list_sub_accounts`, `list_account_courses`, `list_account_users`, `get_account_reports` |
 | Analytics | `search_course_content`, `get_course_analytics`, `get_student_analytics`, `get_course_activity_stream` |
+| Outcomes | `get_root_outcome_group`, `list_outcome_groups`, `list_outcome_group_links`, `get_outcome_group`, `list_outcome_group_outcomes`, `list_outcome_group_subgroups`, `get_outcome`, `get_outcome_alignments`, `get_outcome_results`, `get_outcome_rollups`, `get_outcome_contributing_scores`, `get_outcome_mastery_distribution` |
 | Student | `get_my_courses`, `get_my_grades`, `get_my_submissions`, `get_my_upcoming_assignments` |
 | Dashboard | `get_dashboard_cards`, `get_todo_items`, `get_upcoming_events`, `get_missing_submissions` |
 
-60 tools are read-only and 28 tools perform Canvas write operations.
+72 tools are read-only and 28 tools perform Canvas write operations.
 
 All write tools require appropriate Canvas permissions. Canvas enforces its own permission model -- the MCP server does not bypass it.
 

package/dist/canvas/index.cjs

@@ -2,10 +2,10 @@
 
 
 
-var _chunk4P7LR66Vcjs = require('../chunk-4P7LR66V.cjs');
+var _chunkXAOI3FO6cjs = require('../chunk-XAOI3FO6.cjs');
 
 
 
 
-exports.CanvasApiError = _chunk4P7LR66Vcjs.CanvasApiError; exports.CanvasClient = _chunk4P7LR66Vcjs.CanvasClient; exports.CanvasHttpClient = _chunk4P7LR66Vcjs.CanvasHttpClient;
+exports.CanvasApiError = _chunkXAOI3FO6cjs.CanvasApiError; exports.CanvasClient = _chunkXAOI3FO6cjs.CanvasClient; exports.CanvasHttpClient = _chunkXAOI3FO6cjs.CanvasHttpClient;
 //# sourceMappingURL=index.cjs.map

package/dist/canvas/index.js

@@ -2,7 +2,7 @@ import {
   CanvasApiError,
   CanvasClient,
   CanvasHttpClient
-} from "../chunk-H4CEPP26.js";
+} from "../chunk-XP3FFZQV.js";
 export {
   CanvasApiError,
   CanvasClient,

package/dist/{chunk-VOQ5A7CA.cjs → chunk-VDHNHHYO.cjs}

@@ -2,14 +2,20 @@
 
 
 
-var _chunk4P7LR66Vcjs = require('./chunk-4P7LR66V.cjs');
+
+
+
+
+
+
+var _chunkXAOI3FO6cjs = require('./chunk-XAOI3FO6.cjs');
 
 // src/server.ts
 var _mcpjs = require('@modelcontextprotocol/sdk/server/mcp.js');
 
 // src/tools/errors.ts
 function formatError(error) {
-  if (error instanceof _chunk4P7LR66Vcjs.CanvasApiError) {
+  if (error instanceof _chunkXAOI3FO6cjs.CanvasApiError) {
     const status = error.status;
     const message = error.message;
     switch (status) {
@@ -1580,7 +1586,7 @@ function analyticsTools(canvas) {
       inputSchema: {
         course_id: _zod.z.number().describe("The Canvas course ID"),
         search_term: _zod.z.string().describe("The keyword or phrase to search for"),
-        content_types: _zod.z.array(_zod.z.enum(_chunk4P7LR66Vcjs.SEARCH_CONTENT_TYPES)).optional().describe(
+        content_types: _zod.z.array(_zod.z.enum(_chunkXAOI3FO6cjs.SEARCH_CONTENT_TYPES)).optional().describe(
           "Content types to search. Defaults to all types: pages, discussions, assignments, announcements."
         )
       },
@@ -1592,7 +1598,7 @@ function analyticsTools(canvas) {
         const courseId = params.course_id;
         const searchTerm = params.search_term;
         const types = _nullishCoalesce(params.content_types, () => ( [
-          ..._chunk4P7LR66Vcjs.SEARCH_CONTENT_TYPES
+          ..._chunkXAOI3FO6cjs.SEARCH_CONTENT_TYPES
         ]));
         if (types.length === 0) return { results: [] };
         const settled = await Promise.allSettled(
@@ -1780,6 +1786,228 @@ function dashboardTools(canvas) {
   ];
 }
 
+// src/tools/outcomes.ts
+
+function outcomeTools(canvas) {
+  return [
+    {
+      name: "get_root_outcome_group",
+      description: "Get the root outcome group for an account or course context.",
+      inputSchema: {
+        context_type: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_CONTEXT_TYPES).describe("Whether to read outcomes from an account or course context."),
+        context_id: _zod.z.number().describe("The Canvas account ID or course ID for the context.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.getRootOutcomeGroup(
+        params.context_type,
+        params.context_id
+      )
+    },
+    {
+      name: "list_outcome_groups",
+      description: "List all outcome groups for an account or course context.",
+      inputSchema: {
+        context_type: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_CONTEXT_TYPES).describe("Whether to read outcome groups from an account or course context."),
+        context_id: _zod.z.number().describe("The Canvas account ID or course ID for the context.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.listOutcomeGroups(
+        params.context_type,
+        params.context_id
+      )
+    },
+    {
+      name: "list_outcome_group_links",
+      description: "List all outcome links in an account or course context.",
+      inputSchema: {
+        context_type: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_CONTEXT_TYPES).describe("Whether to read outcome links from an account or course context."),
+        context_id: _zod.z.number().describe("The Canvas account ID or course ID for the context."),
+        outcome_style: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_DETAIL_LEVELS).optional().describe('Outcome detail level. Use "full" to include expanded outcome fields.'),
+        outcome_group_style: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_DETAIL_LEVELS).optional().describe(
+          'Outcome group detail level. Use "full" to include expanded outcome group fields.'
+        )
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.listOutcomeGroupLinks(
+        params.context_type,
+        params.context_id,
+        {
+          outcome_style: params.outcome_style,
+          outcome_group_style: params.outcome_group_style
+        }
+      )
+    },
+    {
+      name: "get_outcome_group",
+      description: "Get details for a specific outcome group in an account or course context.",
+      inputSchema: {
+        context_type: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_CONTEXT_TYPES).describe("The outcome group context type."),
+        context_id: _zod.z.number().describe("The Canvas account ID or course ID for the context."),
+        outcome_group_id: _zod.z.number().describe("The Canvas outcome group ID.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.getOutcomeGroup(
+        params.context_type,
+        params.context_id,
+        params.outcome_group_id
+      )
+    },
+    {
+      name: "list_outcome_group_outcomes",
+      description: "List the linked outcomes directly under a specific outcome group.",
+      inputSchema: {
+        context_type: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_CONTEXT_TYPES).describe("The outcome group context type."),
+        context_id: _zod.z.number().describe("The Canvas account ID or course ID for the context."),
+        outcome_group_id: _zod.z.number().describe("The Canvas outcome group ID."),
+        outcome_style: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_DETAIL_LEVELS).optional().describe('Outcome detail level. Use "full" to include expanded outcome fields.')
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.listGroupOutcomes(
+        params.context_type,
+        params.context_id,
+        params.outcome_group_id,
+        {
+          outcome_style: params.outcome_style
+        }
+      )
+    },
+    {
+      name: "list_outcome_group_subgroups",
+      description: "List the immediate child outcome groups under a specific outcome group.",
+      inputSchema: {
+        context_type: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_CONTEXT_TYPES).describe("The outcome group context type."),
+        context_id: _zod.z.number().describe("The Canvas account ID or course ID for the context."),
+        outcome_group_id: _zod.z.number().describe("The Canvas outcome group ID.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.listGroupSubgroups(
+        params.context_type,
+        params.context_id,
+        params.outcome_group_id
+      )
+    },
+    {
+      name: "get_outcome",
+      description: "Get the full details for a specific learning outcome by ID.",
+      inputSchema: {
+        outcome_id: _zod.z.number().describe("The Canvas outcome ID."),
+        add_defaults: _zod.z.boolean().optional().describe("Include default mastery colors and levels when Canvas supports it.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.getOutcome(params.outcome_id, {
+        add_defaults: params.add_defaults
+      })
+    },
+    {
+      name: "get_outcome_alignments",
+      description: "Get outcome alignments for a course, optionally filtered to a specific student or assignment.",
+      inputSchema: {
+        course_id: _zod.z.number().describe("The Canvas course ID."),
+        student_id: _zod.z.number().optional().describe("Optional Canvas user ID of the student to filter alignments by."),
+        assignment_id: _zod.z.number().optional().describe("Optional Canvas assignment ID to filter alignments by.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.getOutcomeAlignments(params.course_id, {
+        student_id: params.student_id,
+        assignment_id: params.assignment_id
+      })
+    },
+    {
+      name: "get_outcome_results",
+      description: "Get per-student outcome results for a course, with optional outcome, student, and alignment filters.",
+      inputSchema: {
+        course_id: _zod.z.number().describe("The Canvas course ID."),
+        user_ids: _zod.z.array(_zod.z.union([_zod.z.number(), _zod.z.string()])).optional().describe('Optional Canvas user IDs or SIS user IDs prefixed with "sis_user_id:".'),
+        outcome_ids: _zod.z.array(_zod.z.number()).optional().describe("Optional outcome IDs to restrict the results."),
+        include_alignments: _zod.z.boolean().optional().describe("Include linked alignment details in the response."),
+        include_hidden: _zod.z.boolean().optional().describe("Include hidden outcomes when Canvas supports it.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.getOutcomeResults(params.course_id, {
+        user_ids: params.user_ids,
+        outcome_ids: params.outcome_ids,
+        include_alignments: params.include_alignments,
+        include_hidden: params.include_hidden
+      })
+    },
+    {
+      name: "get_outcome_rollups",
+      description: "Get outcome rollups for a course, optionally aggregated or filtered by students, outcomes, and sort options.",
+      inputSchema: {
+        course_id: _zod.z.number().describe("The Canvas course ID."),
+        aggregate: _zod.z.enum(["course"]).optional().describe("Aggregate all student rollups into a single course-level rollup."),
+        aggregate_stat: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_ROLLUP_AGGREGATE_STATS).optional().describe('Statistic to use when aggregate="course".'),
+        user_ids: _zod.z.array(_zod.z.union([_zod.z.number(), _zod.z.string()])).optional().describe('Optional Canvas user IDs or SIS user IDs prefixed with "sis_user_id:".'),
+        outcome_ids: _zod.z.array(_zod.z.number()).optional().describe("Optional outcome IDs to restrict the rollups."),
+        include_courses: _zod.z.boolean().optional().describe("Include linked course details in the response payload."),
+        exclude: _zod.z.array(_zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_EXCLUDE_OPTIONS)).optional().describe("Optional rollup exclusions for missing users or missing outcome results."),
+        sort_by: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_ROLLUP_SORT_BY).optional().describe("Sort rollups by student name or by a specific outcome score."),
+        sort_outcome_id: _zod.z.number().optional().describe('Outcome ID to sort by when sort_by="outcome".'),
+        sort_order: _zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_SORT_ORDER).optional().describe("Sort order to apply when sorting rollups."),
+        add_defaults: _zod.z.boolean().optional().describe("Include default mastery colors and levels when Canvas supports it.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.getOutcomeRollups(params.course_id, {
+        aggregate: params.aggregate,
+        aggregate_stat: params.aggregate_stat,
+        user_ids: params.user_ids,
+        outcome_ids: params.outcome_ids,
+        include_courses: params.include_courses,
+        exclude: params.exclude,
+        sort_by: params.sort_by,
+        sort_outcome_id: params.sort_outcome_id,
+        sort_order: params.sort_order,
+        add_defaults: params.add_defaults
+      })
+    },
+    {
+      name: "get_outcome_contributing_scores",
+      description: "Get assignment or quiz scores that contributed to a specific outcome for one or more students in a course.",
+      inputSchema: {
+        course_id: _zod.z.number().describe("The Canvas course ID."),
+        outcome_id: _zod.z.number().describe("The Canvas outcome ID."),
+        user_ids: _zod.z.array(_zod.z.union([_zod.z.number(), _zod.z.string()])).optional().describe('Optional Canvas user IDs or SIS user IDs prefixed with "sis_user_id:".'),
+        only_assignment_alignments: _zod.z.boolean().optional().describe("Limit results to assignment alignments only."),
+        show_unpublished_assignments: _zod.z.boolean().optional().describe("Include unpublished assignments in the contributing score results.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.getOutcomeContributingScores(
+        params.course_id,
+        params.outcome_id,
+        {
+          user_ids: params.user_ids,
+          only_assignment_alignments: params.only_assignment_alignments,
+          show_unpublished_assignments: params.show_unpublished_assignments
+        }
+      )
+    },
+    {
+      name: "get_outcome_mastery_distribution",
+      description: "Get mastery distribution analytics for outcomes in a course, optionally filtered by students or outcomes.",
+      inputSchema: {
+        course_id: _zod.z.number().describe("The Canvas course ID."),
+        exclude: _zod.z.array(_zod.z.enum(_chunkXAOI3FO6cjs.OUTCOME_EXCLUDE_OPTIONS)).optional().describe("Optional exclusions for missing users or missing outcome results."),
+        outcome_ids: _zod.z.array(_zod.z.number()).optional().describe("Optional outcome IDs to restrict the distribution results."),
+        student_ids: _zod.z.array(_zod.z.union([_zod.z.number(), _zod.z.string()])).optional().describe('Optional Canvas student IDs or SIS user IDs prefixed with "sis_user_id:".'),
+        include_alignment_distributions: _zod.z.boolean().optional().describe("Include contributing score distributions for alignments."),
+        only_assignment_alignments: _zod.z.boolean().optional().describe("When including alignment distributions, limit them to assignments only."),
+        show_unpublished_assignments: _zod.z.boolean().optional().describe("Include unpublished assignments in alignment distributions."),
+        add_defaults: _zod.z.boolean().optional().describe("Include default mastery colors and levels when Canvas supports it.")
+      },
+      annotations: { readOnlyHint: true, openWorldHint: true },
+      handler: async (params) => canvas.outcomes.getOutcomeMasteryDistribution(params.course_id, {
+        exclude: params.exclude,
+        outcome_ids: params.outcome_ids,
+        student_ids: params.student_ids,
+        include_alignment_distributions: params.include_alignment_distributions,
+        only_assignment_alignments: params.only_assignment_alignments,
+        show_unpublished_assignments: params.show_unpublished_assignments,
+        add_defaults: params.add_defaults
+      })
+    }
+  ];
+}
+
 // src/tools/index.ts
 function getAllTools(canvas) {
   return [
@@ -1801,6 +2029,7 @@ function getAllTools(canvas) {
     ...peerReviewTools(canvas),
     ...accountTools(canvas),
     ...analyticsTools(canvas),
+    ...outcomeTools(canvas),
     ...studentTools(canvas),
     ...dashboardTools(canvas)
   ];
@@ -1816,7 +2045,7 @@ function registerAllTools(server, canvas) {
           content: [{ type: "text", text }]
         };
       } catch (error) {
-        if (error instanceof _chunk4P7LR66Vcjs.CanvasApiError) {
+        if (error instanceof _chunkXAOI3FO6cjs.CanvasApiError) {
         } else {
           console.error(`Unexpected error in tool "${tool.name}":`, error);
         }
@@ -1864,7 +2093,7 @@ function registerSyllabusResource(server, canvas) {
           ]
         };
       } catch (error) {
-        if (!(error instanceof _chunk4P7LR66Vcjs.CanvasApiError)) {
+        if (!(error instanceof _chunkXAOI3FO6cjs.CanvasApiError)) {
           console.error("Unexpected error in syllabus resource:", error);
         }
         return {
@@ -1913,7 +2142,7 @@ function registerAssignmentDescriptionResource(server, canvas) {
           ]
         };
       } catch (error) {
-        if (!(error instanceof _chunk4P7LR66Vcjs.CanvasApiError)) {
+        if (!(error instanceof _chunkXAOI3FO6cjs.CanvasApiError)) {
           console.error("Unexpected error in assignment-description resource:", error);
         }
         return {
@@ -1932,7 +2161,7 @@ function registerAllResources(server, canvas) {
 
 // src/server.ts
 function createCanvasMCPServer(config) {
-  const canvas = new (0, _chunk4P7LR66Vcjs.CanvasClient)({
+  const canvas = new (0, _chunkXAOI3FO6cjs.CanvasClient)({
     token: config.token,
     baseUrl: config.baseUrl
   });
@@ -1948,4 +2177,4 @@ function createCanvasMCPServer(config) {
 
 
 exports.createCanvasMCPServer = createCanvasMCPServer;
-//# sourceMappingURL=chunk-VOQ5A7CA.cjs.map
+//# sourceMappingURL=chunk-VDHNHHYO.cjs.map