Skip to main content
Glama
Sign In
Canvas LMS MCP Server

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get Outcome Rollups

get_outcome_rollups
Read-only

Get aggregated outcome rollups for a course — one score per student per outcome, or, with aggregate="course", a single course-level mean or median — optionally filtered by user_ids and outcome_ids and sorted by student or by one outcome's…

Instructions

Get aggregated outcome rollups for a course — one score per student per outcome, or, with aggregate="course", a single course-level mean or median — optionally filtered by user_ids and outcome_ids and sorted by student or by one outcome's score. Set include_courses to nest course details under linked.courses. When CANVAS_PSEUDONYMIZE_STUDENTS is enabled, linked.users entries are anonymized; use resolve_pseudonym to map one back to a real user. Use get_outcome_results instead for the raw per-alignment scores behind a rollup, or get_outcome_mastery_distribution for a mastery-level histogram across students.

Input Schema

NameRequiredDescriptionDefault
excludeNoOptional rollup exclusions for missing users or missing outcome results.
sort_byNoSort rollups by student name or by a specific outcome score.
user_idsNoOptional Canvas user IDs (pass large IDs as strings) or SIS user IDs prefixed with "sis_user_id:".
aggregateNoAggregate all student rollups into a single course-level rollup.
course_idYesThe Canvas course ID.
sort_orderNoSort order to apply when sorting rollups.
outcome_idsNoOptional outcome IDs to restrict the rollups.
add_defaultsNoInclude default mastery colors and levels when Canvas supports it.
aggregate_statNoStatistic to use when aggregate="course".
include_coursesNoInclude linked course details in the response payload.
sort_outcome_idNoOutcome ID to sort by when sort_by="outcome".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv1.18.15
    • addedInput schema / properties / course_id / anyOf
      Added value: +[
+  {
+    "exclusiveMinimum": 0,
+    "maximum": 9007199254740991,
+    "type": "integer"
+  },
+  {
+    "pattern": "^[1-9][0-9]{0,18}$",
+    "type": "string"
+  }
+]
    • removedInput schema / properties / course_id / type
      Removed value: -"number"
    • addedInput schema / properties / outcome_ids / items / anyOf
      Added value: +[
+  {
+    "exclusiveMinimum": 0,
+    "maximum": 9007199254740991,
+    "type": "integer"
+  },
+  {
+    "pattern": "^[1-9][0-9]{0,18}$",
+    "type": "string"
+  }
+]
    • removedInput schema / properties / outcome_ids / items / type
      Removed value: -"number"
    • addedInput schema / properties / sort_outcome_id / anyOf
      Added value: +[
+  {
+    "exclusiveMinimum": 0,
+    "maximum": 9007199254740991,
+    "type": "integer"
+  },
+  {
+    "pattern": "^[1-9][0-9]{0,18}$",
+    "type": "string"
+  }
+]
    • removedInput schema / properties / sort_outcome_id / type
      Removed value: -"number"
    • changedInput schema / properties / user_ids / description
      Previous value: -"Optional Canvas user IDs or SIS user IDs prefixed with \"sis_user_id:\"."New value: +"Optional Canvas user IDs (pass large IDs as strings) or SIS user IDs prefixed with \"sis_user_id:\"."
    • addedInput schema / properties / user_ids / items / anyOf
      Added value: +[
+  {
+    "exclusiveMinimum": 0,
+    "maximum": 9007199254740991,
+    "type": "integer"
+  },
+  {
+    "pattern": "^[1-9][0-9]{0,18}$",
+    "type": "string"
+  },
+  {
+    "pattern": "^sis_user_id:[\\s\\S]+$",
+    "type": "string"
+  }
+]
    • removedInput schema / properties / user_ids / items / type
      Removed value: -[
-  "number",
-  "string"
-]
  2. Changed1 schema field changedv1.18.11
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Changed2 schema fields changedv1.18.8
    • removedInput schema / properties / user_ids / items / anyOf
      Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "string"
-  }
-]
    • addedInput schema / properties / user_ids / items / type
      Added value: +[
+  "number",
+  "string"
+]
  4. First observedv1.18.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, and the description adds real behavior beyond that: pseudonymization of linked.users when CANVAS_PSEUDONYMIZE_STUDENTS is enabled, the resolve_pseudonym follow-up, and how include_courses nests data under linked.courses. It does not discuss pagination or response size limits, which keeps it just below a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Dense but front-loaded: the primary output shape and the aggregate mode come first, alternatives come last. Every clause carries information, though the single long sentence is heavy on nested parentheticals.

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

Completeness4/5

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

For an 11-parameter tool with no output schema, the description does a good job explaining the shape of the response (per-student rows, linked.courses nesting, anonymized linked.users) and the filtering/sorting model. Minor gaps on exclude semantics keep it from a 5.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds cross-parameter meaning the schema can't convey: aggregate="course" pairs with aggregate_stat mean/median, and sort_by="outcome" requires sort_outcome_id, and include_courses controls response nesting. It doesn't cover exclude or add_defaults, so not a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource (aggregated outcome rollups for a course) and defines the two output shapes: one score per student per outcome, or a single course-level mean/median with aggregate="course". It is clearly distinguishable from get_outcome_results and get_outcome_mastery_distribution.

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

Usage Guidelines5/5

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

Explicitly names both alternatives and the condition that selects them: get_outcome_results for raw per-alignment scores, get_outcome_mastery_distribution for a mastery histogram. It also explains when to use resolve_pseudonym, leaving little to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools