Skip to main content
Glama

List Course Enrollments

list_course_enrollments
Read-only

List enrollments for a specific Canvas course, filtering by role, user, or state, and include grades or current points for richer data.

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 (may be numeric ID 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. Dates show when Glama detected each change.

  1. 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"
      +]
  2. 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 provide readOnlyHint=true and openWorldHint=true, covering the read-only nature. The description adds no behavioral context like pagination behavior, default enrollment states, or response format—it focuses on filter parameters rather than runtime behavior.

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?

Two concise sentences: the first states the tool's purpose, the second surfaces the most valuable parameter usage notes. No repetition of schema details and no filler.

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?

The description covers core purpose and key filter hints, but with no output schema and 8 parameters, an agent might still need to know default enrollment states, pagination behavior, or how the response is structured. Schema documents parameters well, but response semantics are left unstated.

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% with solid parameter descriptions, but the description adds practical meaning by highlighting include=grades/current_points for richer grade data, type[] for role filtering, and user_id for focusing on a single user—tips beyond the schema text.

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 uses a specific verb 'List' and clearly identifies the resource: 'enrollments within a specific course'. The course-scoped phrasing distinguishes it from the general sibling list_enrollments, though it doesn't name the alternative explicitly.

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?

The description offers concrete parameter usage guidance (include=grades, type[], user_id) and implies the tool is for course-scoped enrollment queries, but it does not explicitly state when to prefer this tool over list_enrollments or mention exclusions such as cross-course queries.

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