Skip to main content
Glama

get_outcome_rollups

Read-only

Retrieve outcome rollups for a Canvas course. Optionally aggregate by course, filter by students or outcomes, sort, and include course details.

Instructions

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

Input Schema

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

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

Annotations already declare readOnlyHint=true and openWorldHint=true. The description adds no new behavioral insights beyond summarizing parameter options, nor does it mention response size, performance, or required permissions.

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?

The description is a single sentence that is appropriately front-loaded with the core action. It is concise and avoids redundancy, though a brief note on return value could improve structure.

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 no sibling differentiation, the description covers the basic purpose but lacks crucial context on result format and when to choose this tool over others.

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?

All parameters have schema descriptions (100% coverage), so the baseline is 3. The description only restates the schema's optional filtering and sorting, adding no deeper semantics or usage context.

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?

The description clearly states the action 'Get outcome rollups for a course' with optional aggregations and filters. It distinguishes from sibling tools like get_outcome_results by focusing on rollups, but does not explicitly contrast with all related tools.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives such as get_outcome_results or get_outcome_mastery_distribution. The description does not specify prerequisites, limitations, or exclusions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bruchris/canvas-lms-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server