Skip to main content
Glama

list_users_in_course

List users in a Canvas course by role. Filter by teacher, student, TA, observer, or search by name or email. Optionally include email addresses for a simple course roster without enrollment details.

Instructions

List users in a course by role (teacher, student, ta, observer). Simpler output than list_students — use list_students when you need enrollment details like section, activity time, or state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesCanvas course ID
search_termNoFilter by name or email substring
include_emailNoInclude email addresses in results
enrollment_typeNoFilter by enrollment role
Behavior3/5

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

There are no annotations, so the description must disclose behavior. It reveals the output is simpler than list_students, but does not detail pagination, response format, authentication needs, or any side effects. The added context is useful but incomplete.

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 filler. The first sentence states the purpose, the second gives usage guidance. Every word earns its place.

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 simple list tool with full schema coverage, the description is mostly sufficient. The comparison with list_students clarifies output scope, but without an output schema, return-field details are somewhat underspecified. Still, the core usage is clear.

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% and all parameters have descriptions, so the baseline is 3. The description adds no extra parameter meaning; it merely lists role examples that are already in the schema enum, and omits 'designer' from the list.

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 users in a course' and allows filtering 'by role', with specific examples. It also explicitly differentiates itself from the sibling list_students, making its purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit guidance on when to use this tool vs list_students: 'Simpler output' versus needing 'enrollment details like section, activity time, or state.' This gives the agent a clear decision rule.

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/hughsibbele/Canvas-Agent'

If you have feedback or need assistance with the MCP directory API, please join our Discord server