Skip to main content
Glama
Fireiscoolsolo

Canvas LMS MCP – Remote Edition

List Course Users

list_course_users
Read-onlyIdempotent

Retrieve course members with names, roles, and user IDs, and filter by enrollment role or name to get a roster.

Instructions

List people in a course with names, roles and user IDs, optionally filtered by role or name. Read-only. Your school's privacy settings often limit or block this for students.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of items to return. Smaller is faster.
course_idYesCanvas course ID, a numeric string such as "12345". Get it from list_courses.
search_termNoOptional text filter on names or titles (at least 2 characters, case-insensitive).
enrollment_typeNostudent, teacher, ta, observer, designer

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.1.3
    • changedInput schema / properties / course_id / description
      Previous value: -"Canvas course ID"New value: +"Canvas course ID, a numeric string such as \"12345\". Get it from list_courses."
    • changedInput schema / properties / limit / description
      Previous value: -"Max items to return"New value: +"Maximum number of items to return. Smaller is faster."
    • addedInput schema / properties / search_term / description
      Added value: +"Optional text filter on names or titles (at least 2 characters, case-insensitive)."
  2. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, so the safety profile is covered. The description repeats 'Read-only' but adds valuable non-annotation context: school privacy settings may limit or block results for students. It does not describe pagination or rate-limit behavior, so it falls short of a 5.

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?

Three short sentences, front-loaded with the core purpose and filters, followed by a safety note and a privacy caveat. No wasted language.

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 read-only list tool with full schema coverage and annotations, the description covers scope, filters, and an important environmental constraint (privacy settings). It does not mention pagination or output shape, but no output schema exists and the complexity is low, so it is nearly complete.

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 description coverage is 100%, so all four parameters are already documented in the schema. The description mentions filtering by role or name, which corresponds to enrollment_type and search_term, but adds no syntax or format details beyond the schema. Baseline 3 is appropriate.

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?

The description states a specific verb and resource: 'List people in a course with names, roles and user IDs.' It also names the optional filters. The purpose is clear enough to distinguish this from siblings such as get_user_in_course (single user) and list_group_members (group context), although no sibling is explicitly named for contrast.

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?

Usage is implied by 'List people in a course' and the mention of optional role/name filters. The privacy caveat ('often limit or block this for students') gives useful context about when the tool may fail, but there is no explicit when-to-use/when-not-to-use guidance or named alternative.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools