Skip to main content
Glama

List Course Enrollments

list_course_enrollments
Read-only

Retrieve Canvas course enrollments with filters for role, state, user, and optional grade 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
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 agent knows it's a safe read operation. The description adds filter guidance but doesn't discuss return behavior, pagination, or other operational aspects, keeping it at baseline.

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, front-loaded with the core purpose, followed by high-value filter examples. Every word earns its place with no fluff or redundancy.

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 filtered-list tool with comprehensive annotations and full schema coverage, the description adequately covers usage. It could mention pagination or response format, but given the simplicity of the operation, this is sufficient.

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?

With 100% schema coverage, the baseline is 3, but the description enriches parameter meaning by explaining the purpose of combining include=grades/current_points (richer grade data), type[] (role limitation), and user_id (single user focus). This goes beyond the schema's basic field descriptions.

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 the tool lists enrollments within a specific course, with a specific verb and resource. It distinguishes from siblings like list_enrollments (which is broader) by emphasizing course-level filtering.

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 explicit examples of when to use include, type, and user_id filters, providing clear context on usage scenarios. However, it does not name alternative tools or explicitly state when not to use this tool, falling slightly short of a 5.

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