Skip to main content
Glama

list_enrollments

Read-only

Lists all enrollments for the authenticated user across Canvas courses, with optional filters for type, state, role, and includes.

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
typeNoFilter by one or more enrollment types
stateNoFilter by one or more enrollment states
roleNoFilter by enrollment role names (as defined in the Canvas account)
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?

Annotations already provide readOnlyHint=true and openWorldHint=true, so the description's statement about mirroring Canvas API adds minimal behavioral context. It does not disclose details like pagination, rate limits, or data freshness, but does not contradict annotations either.

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 sentences with no wasted words. The purpose is front-loaded, and the additional context about the Canvas API mirror is concise and informative.

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 list tool with good annotations, the description is sufficient. It references a known API to help infer output structure. However, it could explicitly differentiate from course-level enrollment listing to avoid confusion with siblings.

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 descriptions for each parameter. The description adds value by stating that the optional filters and includes mirror the Canvas API, providing overarching context that ties parameters to an external reference beyond the schema.

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 clearly states 'List all enrollments for the authenticated user across courses', specifying the verb, resource, and scope. It distinguishes from siblings like list_course_enrollments by focusing on the user's enrollments rather than a specific course's enrollments.

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 mentions optional filters and mirrors a Canvas API endpoint, implying when to use it. However, it does not explicitly state when not to use alternatives like list_course_enrollments, leaving room for ambiguity.

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