Skip to main content
Glama

list_enrollments

Read-only

Retrieve all enrollments for the authenticated user across courses, with optional filters for type, state, role, and includes like grades.

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 declare readOnlyHint=true and openWorldHint=true, so the description's reference to the Canvas API adds minimal behavioral context. It does not contradict annotations nor provide additional crucial details beyond what annotations convey.

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 two sentences, front-loads the purpose, and is free of extraneous information. Every word earns its place.

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?

No output schema exists, and the description does not describe what the returned data looks like (e.g., an array of enrollment objects). However, the reference to the Canvas API compensates somewhat. For a tool with 6 parameters and no output schema, more explanation could be beneficial.

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 coverage is 100% with descriptions for all 6 parameters. The description does not add extra parameter-level meaning beyond the schema, such as formatting or usage tips. A score of 3 is appropriate for high 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 clearly states 'List all enrollments for the authenticated user across courses,' specifying the verb, resource, and scope. It also references the exact Canvas API endpoint, which distinguishes it from similar tools like list_course_enrollments.

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 implies usage by saying 'across courses' but does not explicitly compare to alternative tools like list_course_enrollments. No guidance on when to use this vs. other enrollment-related tools is provided.

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