Skip to main content
Glama

List Enrollments

list_enrollments
Read-only

Retrieve all course enrollments for the authenticated user. Filter by role, type, state, term, or grading period to narrow results.

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
Behavior3/5

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

The readOnlyHint annotation already signals a safe read operation, and the description consistently says 'List all enrollments.' It adds contextual detail by specifying the authenticated-user scope and that filters mirror the Canvas endpoint, though it does not dwell on pagination or response shape, which is acceptable given the annotation.

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?

The description is brief and front-loaded, using two sentences to convey the core action, scope, and a useful pointer to the API reference. Every sentence earns its place, with no redundancy or filler.

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?

For a read-only listing tool with all 6 parameters documented and readOnly annotation supplied, the description is sufficiently complete. It clarifies the user scope, optionality/Canvas correspondence, and explicitly indicates the result is a list of enrollments. The lack of an output schema does not create ambiguity here.

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 covers 100% of parameters with descriptions. The description adds that filters and includes are an optional mirror of the Canvas endpoint, but does not introduce meaning beyond the schema. This matches the baseline of 3 for high schema coverage.

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 states the tool lists all enrollments for the authenticated user across courses, using a specific verb and resource scope. It distinguishes from sibling tools like list_course_enrollments by explicitly noting the cross-course, self-scoped behavior, and references the exact Canvas API endpoint.

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 clearly indicates the tool is scoped to the authenticated user's enrollments across all courses, providing context on when to use it. It does not explicitly name alternatives or provide exclusions, so it misses full guidance, but the scope is unambiguous.

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