Skip to main content
Glama

Get Outcome Results

get_outcome_results
Read-only

Get raw per-student, per-alignment outcome results for a course (one score per assessed alignment, not aggregated), optionally filtered by user_ids, outcome_ids, and include_hidden.

Instructions

Get raw per-student, per-alignment outcome results for a course (one score per assessed alignment, not aggregated), optionally filtered by user_ids, outcome_ids, and include_hidden. Set include_alignments to nest the matching alignments under linked.alignments. 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_rollups instead for aggregated scores per student and outcome, or get_outcome_contributing_scores for the assignment or quiz scores behind one outcome.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "course_id": "<course_id>"
    },
    "name": "get_outcome_results"
  }
}

Input Schema

NameRequiredDescriptionDefault
user_idsNoOptional Canvas user IDs (pass large IDs as strings) or SIS user IDs prefixed with "sis_user_id:".
course_idYesThe Canvas course ID.
outcome_idsNoOptional outcome IDs to restrict the results.
include_hiddenNoInclude hidden outcomes when Canvas supports it.
include_alignmentsNoInclude linked alignment details in the response.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 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"
    • 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.4/5.0
Behavior4/5

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

Annotations only declare readOnlyHint and openWorldHint; the description adds real behavioral context beyond that — pseudonymized linked.users when CANVAS_PSEUDONYMIZE_STUDENTS is enabled, plus the linked.alignments nesting triggered by include_alignments. It stops short of covering pagination, result-size limits, or performance characteristics for what could be a large per-student dataset, which keeps it 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.

Conciseness5/5

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

Three dense sentences with no waste: the first defines the output shape and filters, the second covers nesting and pseudonymization behavior, the third handles sibling routing. The distinguishing detail ('not aggregated') is front-loaded rather than buried.

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?

No output schema exists, but the description compensates by describing the return shape (per-student, per-alignment scores; linked.alignments; linked.users) and the anonymization caveat. Minor gap: it references resolve_pseudonym, which is not present in the sibling tool list, so the agent may not find that follow-up tool by name.

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?

With 100% schema description coverage the schema already explains all five parameters, so baseline 3 applies. The description adds only one genuine detail beyond the schema — that include_alignments nests matches under linked.alignments — while user_ids, outcome_ids, and include_hidden semantics are already fully documented in 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?

States a specific verb and resource with precise scope: 'raw per-student, per-alignment outcome results ... one score per assessed alignment, not aggregated.' The non-aggregated framing immediately separates it from rollup-style siblings, so an agent can identify it without opening the schema.

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 routes to alternatives: 'Use get_outcome_rollups instead for aggregated scores per student and outcome, or get_outcome_contributing_scores for the assignment or quiz scores behind one outcome.' It also states the filter conditions (user_ids, outcome_ids, include_hidden) that select this tool over those siblings.

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