Skip to main content
Glama
Canvas LMS MCP – Remote Edition

Canvas LMS MCP – Remote Edition

List Course Users

list_course_users
Read-onlyIdempotent

Lists course members with names, roles, and user IDs, and filters results by role or name. Use it to identify participants or resolve user IDs in a Canvas course.

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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "course_id": "<course_id>"
    },
    "name": "list_course_users"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoWhich page of results to show, starting at 1. Use it when a result says there are more.
limitNoMaximum number of items to return (one page of results). 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. Changed2 schema fields changedv1.3.0
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of items to return. Smaller is faster."New value: +"Maximum number of items to return (one page of results). Smaller is faster."
    • addedInput schema / properties / page
      Added value: +{
      +  "description": "Which page of results to show, starting at 1. Use it when a result says there are more.",
      +  "exclusiveMinimum": 0,
      +  "maximum": 9007199254740991,
      +  "type": "integer"
      +}
  2. 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)."
  3. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and open-world, so the 'Read-only' sentence adds little. The privacy-restriction warning is genuine added context beyond annotations and is exactly the kind of failure mode an agent needs to anticipate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with purpose before the caveat; nothing is buried. The only redundancy is the 'Read-only' clause, which repeats readOnlyHint from the annotations.

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 no output schema, the description does the necessary work of naming the returned fields, and the schema handles pagination. What is missing is the response envelope shape (e.g. whether totals/more-pages metadata is returned alongside the list), which would help an agent page correctly.

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%, with each parameter documented including enum-like values for enrollment_type and pagination semantics. The description's mention of filtering by role or name merely restates enrollment_type and search_term, adding no syntax or format detail beyond the schema, so baseline 3 applies.

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 opens with a specific verb and resource ('List people in a course') and enumerates the fields returned (names, roles, user IDs) plus the available filters. It implicitly separates itself from group-scoped or single-user siblings like list_group_members and get_user_in_course, but never names them, so an agent gets no explicit differentiation.

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?

It gives a useful operational caveat ('privacy settings often limit or block this for students'), which tells the agent when the call may fail. However, there is no guidance on when to prefer this over get_user_in_course or list_group_members, and no prerequisites such as needing teacher/TA enrollment to get full results.

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