Skip to main content
Glama
bruchris

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get Outcome Rollups

get_outcome_rollups
Read-only

Get outcome rollups for a course, optionally aggregated or filtered by students, outcomes, and sort options.

Instructions

Get outcome rollups for a course, optionally aggregated or filtered by students, outcomes, and sort options.

Input Schema

TableJSON 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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds only that rollups can be aggregated/filtered; it says nothing about permissions, pagination, or response size, so with structured data carrying the safety burden a 3 is appropriate.

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?

A single front-loaded sentence with no wasted words. It is efficient, though it arguably under-specifies for an 11-parameter tool rather than being fully concise-but-complete.

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

Completeness3/5

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

With 11 parameters, no output schema, and several dependent relationships (aggregate with aggregate_stat, sort_by='outcome' with sort_outcome_id, the exclude options), the description leaves interactions unexplained. The 100% schema coverage compensates partially, but for this parameter count it is only minimally adequate.

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 every one of the 11 parameters is already documented in the schema. The description's mention of students, outcomes, and sort options loosely maps to those params but adds no syntax or interaction detail, so baseline 3 applies.

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?

States a specific verb ('Get') and resource ('outcome rollups') scoped to a course, which is more precise than the bare name. However it never distinguishes this from closely related siblings like get_outcome_results, get_outcome_contributing_scores, or get_outcome_mastery_distribution, leaving the agent to infer which outcome-based tool fits.

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

Usage Guidelines3/5

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

The description lists available operations ('aggregated or filtered by students, outcomes, and sort options') but gives no when-to-use guidance and no exclusions relative to the many sibling outcome tools. Usage is only implied by the phrase 'for a course'.

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