Skip to main content
Glama

List Course Enrollments

list_course_enrollments
Read-only

List enrollments within a specific course with Canvas filters. Use include=grades / include=current_points for richer grade data, type[] to limit to a role, and user_id to focus on a single user.

Instructions

List enrollments within a specific course with Canvas filters. Use include=grades / include=current_points for richer grade data, type[] to limit to a role, and user_id to focus on a single user.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roleNoFilter by custom role names
typeNoFilter by one or more enrollment types
stateNoFilter by enrollment states
includeNoExtra fields to include (Canvas include[] param)
user_idNoFilter to a specific user. Canvas ID (pass large IDs as a string) or "self".
course_idYesThe Canvas course ID
grading_period_idNoScope grade-related includes to this grading period
enrollment_term_idNoLimit to enrollments in the given term

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 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 / enrollment_term_id / anyOf
      Added value: +[
      +  {
      +    "exclusiveMinimum": 0,
      +    "maximum": 9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "pattern": "^[1-9][0-9]{0,18}$",
      +    "type": "string"
      +  }
      +]
    • removedInput schema / properties / enrollment_term_id / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / enrollment_term_id / minimum
      Removed value: --9007199254740991
    • removedInput schema / properties / enrollment_term_id / type
      Removed value: -"integer"
    • addedInput schema / properties / grading_period_id / anyOf
      Added value: +[
      +  {
      +    "exclusiveMinimum": 0,
      +    "maximum": 9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "pattern": "^[1-9][0-9]{0,18}$",
      +    "type": "string"
      +  }
      +]
    • removedInput schema / properties / grading_period_id / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / grading_period_id / minimum
      Removed value: --9007199254740991
    • removedInput schema / properties / grading_period_id / type
      Removed value: -"integer"
    • addedInput schema / properties / user_id / anyOf
      Added value: +[
      +  {
      +    "exclusiveMinimum": 0,
      +    "maximum": 9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "pattern": "^[1-9][0-9]{0,18}$",
      +    "type": "string"
      +  },
      +  {
      +    "const": "self",
      +    "type": "string"
      +  }
      +]
    • changedInput schema / properties / user_id / description
      Previous value: -"Filter to a specific user (may be numeric ID or \"self\")"New value: +"Filter to a specific user. Canvas ID (pass large IDs as a string) or \"self\"."
    • removedInput schema / properties / user_id / 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_id / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "string"
      -  }
      -]
    • addedInput schema / properties / user_id / type
      Added value: +[
      +  "number",
      +  "string"
      +]
  4. First observedv1.18.0

TDQS

A3.6/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 filter-oriented hints but says nothing about pagination, result volume, or return format for a potentially large enrollment list.

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?

Two dense sentences, scoped purpose front-loaded before the parameter guidance. Efficient, though the second sentence packs several param hints without much breathing room.

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?

With 8 fully documented parameters, covering annotations, and no output schema to explain, the description supplies adequate guidance for correct invocation. It leaves minor gaps around result size/pagination but is otherwise complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema by explaining the intent of include=grades/current_points ('richer grade data'), type[] ('limit to a role'), and user_id ('focus on a single user').

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?

Clear verb (List) plus resource (enrollments) and explicit scope (within a specific course) with mention of Canvas filters. It does not, however, distinguish itself from the sibling list_enrollments, so an agent could confuse the two.

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?

Offers contextual guidance on how to use certain params (include=grades for richer data, type[] to limit to a role, user_id for one user), which implies usage. It never states when to prefer this over list_enrollments or list_course_users, so selection between siblings is left to inference.

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