Skip to main content
Glama
Sign In
vishalsachdev

Canvas MCP Server

by vishalsachdev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

List Users

list_users
Read-only

Retrieves all users enrolled in a specified Canvas course by course code or ID.

Instructions

List users enrolled in a specific course.

Input Schema

NameRequiredDescriptionDefault
course_identifierYesCourse code or Canvas ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.10.0
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "type": "string"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "type": "object",
-  "x-fastmcp-wrap-result": true
-}New value: +null
  2. Changed7 schema fields changedv1.8.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / course_identifier / description
      Added value: +"Course code or Canvas ID"
    • removedInput schema / properties / course_identifier / title
      Removed value: -"Course Identifier"
    • removedInput schema / title
      Removed value: -"list_usersArguments"
    • removedOutput schema / properties / result / title
      Removed value: -"Result"
    • removedOutput schema / title
      Removed value: -"list_usersOutput"
    • addedOutput schema / x-fastmcp-wrap-result
      Added value: +true
  3. Changed1 schema field changedv1.0.0
    • addedInput schema / title
      Added value: +"list_usersArguments"
  4. First observed

TDQS

A3.6/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes that this is a safe read operation, so the description's burden is lighter. It adds the meaningful scoping constraint that only users enrolled in the specified course are returned, but it says nothing about visibility permissions, pagination, enrollment-state filtering, or the shape of the result.

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?

One short sentence with zero waste, and the key scoping constraint is front-loaded. Every word contributes to identifying the tool's resource and scope.

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 with one fully documented parameter and readOnlyHint annotations, the description covers the essential scope. It is slightly under-informative about result format and pagination, but that is a minor gap for this tool's complexity.

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%, and the single course_identifier parameter is already documented as accepting a course code or Canvas ID. The description reinforces the course scoping but adds no syntax, format, or edge-case semantics beyond the schema.

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?

States a specific verb and resource ('List users') plus the scoping qualifier ('enrolled in a specific course'), which is enough to distinguish it from course-listing and group-membership tools. It does not explicitly name or contrast with the nearest siblings, so it stops short of a 5.

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: call this when you need the roster of users enrolled in a given course. There is no explicit when-not condition, no mention of alternatives such as get_group_members or list_groups, and no prerequisite guidance.

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