Skip to main content
Glama
bruchris

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List Course Enrollments

list_course_enrollments
Read-only

List enrollments in a course, filtered by role, state, or user. Optionally include grades and 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.

  1. 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"
  2. 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"
+]
  3. First observedv1.18.0

TDQS

A4/5.0
Behavior3/5

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

The annotations already indicate readOnlyHint=true and openWorldHint=true, so the description doesn't need to repeat safety. It does not add much behavioral context beyond the filtering and inclusion suggestions, but it does clarify that 'user_id' can be 'self', which is useful. The description is consistent with the readOnlyHint; no contradiction.

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?

The description is concise and front-loaded, with a clear purpose in the first sentence followed by specific usage examples. It wastes no words and effectively conveys key configuration tips.

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?

The description, combined with the rich schema and readOnlyHint, provides sufficient context for an agent to call this tool correctly. It covers key parameters and use cases. However, it doesn't explain return details (e.g., pagination, response structure), but that is not critical given the schema's richness and lack of output schema.

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?

The input schema has 100% coverage for all 8 parameters, with detailed descriptions for each (e.g., role filters, state enum, include options). The description adds minimal additional meaning, only reinforcing with examples like 'include=grades' and 'type[]' and 'user_id'. Baseline 3 is appropriate given the schema's thoroughness.

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?

The description starts with a clear verb and resource ('List enrollments within a specific course'), and explains the available filters and includes. It distinguishes itself from siblings like 'list_enrollments' by focusing on course scope and specific Canvas filters, making its purpose immediately clear.

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

Usage Guidelines4/5

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

The description gives specific examples of when to use the tool ('use include=grades...', 'type[] to limit...'), providing clear guidance on how to configure the request. However, it does not explicitly state when not to use this tool or mention alternatives like 'list_enrollments' for cross-course queries.

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