Skip to main content
Glama
bruchris

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get Outcome Rollups

get_outcome_rollups
Read-only

Retrieve outcome rollups for a Canvas course, with options to filter by students or outcomes, aggregate results, and sort by student or outcome.

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 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. 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"
  2. 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"
+]
  3. First observedv1.18.0

TDQS

A3.9/5.0
Behavior3/5

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

With readOnlyHint and openWorldHint already covering the safety profile, the description adds only the option of aggregating/filtering, which is a modest behavioral note about how the result set can change scope. It does not describe pagination, default scope, or payload shape, so it does not go far beyond the annotations.

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

Conciseness5/5

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

A single sentence front-loads the verb and resource, then summarizes the optional axes in nine words. No filler or repetition.

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?

For an 11-parameter endpoint with no output schema, the high-level sentence is lean; it omits the default rollup scope (e.g., all students), how aggregate interacts with sort, and return envelope details. Rich schema descriptions compensate partly, but the description alone leaves an agent with open questions about default behavior.

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 covers 100% of parameters with descriptions, so the baseline is 3. The description's mention of 'aggregated or filtered by students, outcomes, and sort options' adds a light conceptual frame but no detail beyond the schema.

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?

The description names a specific verb ('Get'), a distinct resource ('outcome rollups'), and a clear scope ('for a course'), and it previews the aggregation/filtering options. This distinguishes it from sibling outcome endpoints like get_outcome_results or get_outcome_contributing_scores even without naming them.

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

Usage Guidelines4/5

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

It clearly frames when the tool is appropriate: whenever a course-level outcome rollup is needed, and it signals that aggregation/filtering is optional so agents know the base call is a simple rollup. It does not explicitly name alternative endpoints or state when not to use it, but the intended context is reasonably clear.

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