Skip to main content
Glama

list_course_users

Read-only

Retrieve users in a Canvas course with optional filters for enrollment type, state, roles, and additional fields like email or enrollments. Supports searching by name or ID and sorting.

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

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

Annotations declare readOnlyHint=true, so the description doesn't need to state safety. It adds behavioral context like 'fields otherwise omitted from the default response' and ability to fetch specific user_ids. However, it lacks details on pagination, default behavior, or rate limits, which would be helpful for a list tool.

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, front-loaded paragraph that efficiently covers the tool's purpose and key parameters without unnecessary words. Every sentence adds value.

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?

Given the tool's complexity (8 parameters, multiple filters, no output schema), the description covers filtering capabilities and include options. It misses mention of pagination, default sort, or error handling, but overall is sufficient for agent selection.

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%, but description adds meaning beyond schema: it explains the purpose of include (request extra fields), and the effect of enrollment_type/state, search_term, user_ids, and sort/order. This enhances parameter understanding beyond the terse schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states 'List users in a course' with specific verb and resource, and enumerates optional filters. However, it does not explicitly differentiate from sibling tools like list_students or list_course_enrollments, so it loses a point for sibling distinction.

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?

Description explains when to use each parameter (e.g., 'Use enrollment_type to narrow by role'), but does not provide guidance on when to prefer this tool over alternatives like list_students or search_users. No when-not-to-use advice is given.

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