Skip to main content
Glama
bruchris

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List Enrollments

list_enrollments
Read-only

List all enrollments for the authenticated user across courses. Optional filters and includes mirror Canvas GET /users/self/enrollments.

Instructions

List all enrollments for the authenticated user across courses. Optional filters and includes mirror Canvas GET /users/self/enrollments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roleNoFilter by enrollment role names (as defined in the Canvas account)
typeNoFilter by one or more enrollment types
stateNoFilter by one or more enrollment states
includeNoExtra fields to include on each enrollment (Canvas include[] param)
grading_period_idNoReturn enrollments scoped to this grading period
enrollment_term_idNoLimit to enrollments in the given term

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv1.18.15
    • 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"
  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. First observedv1.18.0

TDQS

B3.2/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 the user-scoped 'across courses' framing, but says nothing about pagination, result limits, or auth requirements beyond what annotations imply.

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 tight sentences with the resource and scope front-loaded and no wasted words. Slightly under-informative rather than bloated.

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?

A read-only list tool with full schema coverage and annotations covering safety; the minimum is met. However, with no output schema, the description could say more about what is returned (enrollment records per course) and pagination behavior.

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 description coverage is 100%, so every parameter is already documented in the schema. The description only notes that filters and includes mirror the Canvas endpoint, adding no syntax or format detail beyond the schema. Baseline 3 is correct.

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?

States a specific verb (list) and resource (enrollments) and adds a meaningful scope qualifier: 'for the authenticated user across courses.' This distinguishes it in spirit from course-scoped siblings, though it never names list_course_enrollments explicitly.

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

Usage Guidelines2/5

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

No when-to-use or when-not-to-use guidance. The sibling list_course_enrollments is the obvious alternative for course-scoped queries, but the description offers no routing logic between the two; the Canvas endpoint reference is background, not usage guidance.

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