Skip to main content
Glama

get_outcome_rollups

Read-only

Retrieve course outcome rollups with optional aggregation, filtering by students or outcomes, and sorting by name or score.

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.
Behavior3/5

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

Annotations already declare readOnlyHint=true, so description doesn't need to restate. It adds scope context (course) and options, but no additional behavioral traits like rate limits or response structure.

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?

Single, front-loaded sentence of 20 words efficiently communicates purpose and key options.

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 and no output schema, description could elaborate on the rollup concept, aggregation behavior, or sorting effects. Currently adequate but leaves gaps for complex parameter interactions.

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 coverage is 100%, so description adds no new meaning beyond stating 'optionally aggregated or filtered'. Baseline score of 3 applies.

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?

Description clearly states verb 'Get', resource 'outcome rollups', scope 'for a course', and optional aggregation/filtering options. It distinguishes from sibling tools like get_outcome_results by specifying rollups.

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?

Description implies usage scenarios through words like 'optionally aggregated or filtered', but does not explicitly state when to use vs. alternatives (e.g., get_outcome_results) or when not to use.

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