Skip to main content
Glama

list_course_users

Read-only

Retrieve users enrolled in a Canvas course, with optional filters for enrollment type, state, user IDs, search term, and custom fields like email or enrollments.

Instructions

List users in a course with optional Canvas filters. Use include to request email, enrollments, avatar_url, bio, and other fields otherwise omitted from the default response. Use enrollment_type / enrollment_state to narrow by role or status, search_term to filter by name/login, user_ids to fetch a specific subset, and sort/order to control ordering.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesThe Canvas course ID
enrollment_typeNoFilter by one or more enrollment types
enrollment_stateNoFilter by enrollment state (e.g. active, invited)
includeNoExtra fields to include on each user (Canvas include[] param)
user_idsNoRestrict the result to the given user IDs
search_termNoPartial name or full login/SIS ID to filter users by
sortNoSort field
orderNoSort order
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint. The description adds behavioral context by explaining that certain fields are omitted by default and how to request them via include, and that filters narrow results. No contradictions.

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 a single, well-structured sentence that front-loads the core purpose and then efficiently enumerates parameter usage. Every clause serves a purpose with no 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?

With 8 parameters and no output schema, the description covers all parameter uses but omits details like pagination, default response structure, and result limits. Still, it is largely complete given the tool's straightforward nature.

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%, so baseline is 3. The description adds value by explaining the purpose of each parameter in a cohesive sentence (e.g., 'Use enrollment_type / enrollment_state to narrow by role or status'), going beyond the schema's individual 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 starts with 'List users in a course with optional Canvas filters,' which clearly states the action and resource. It distinguishes from sibling tools like list_courses and list_course_enrollments by specifying 'users in a course'.

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 provides explicit guidance for each parameter (e.g., 'Use include to request...', 'Use enrollment_type/enrollment_state to narrow...'), but does not directly compare to sibling tools like list_course_enrollments or explain when to choose this one instead.

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