Skip to main content
Glama
Sign In
Canvas LMS MCP Server

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List Appointment Groups

list_appointment_groups
Read-only

Lists Canvas Scheduler appointment groups visible to the current user, filtered by reservable or manageable scope, with optional time slots, reservations, and participant counts.

Instructions

List appointment groups (Canvas Scheduler sign-up slots) visible to the current user, returning each group's id, title, context_codes, workflow_state, and location — time slots, per-slot reservations, and participant counts are each left out unless you pass the matching include value. scope defaults to "reservable" (groups the user is eligible to sign up for; reserving a slot itself happens in the Canvas UI, not through this server) and can be set to "manageable" for the groups the user administers. Fetches every page (100 per request) and fails with a 'Results are incomplete' error instead of silently truncating. Use get_appointment_group for one group's full detail by id, and next_appointment to find the next open slot instead of browsing every group.

Input Schema

NameRequiredDescriptionDefault
scopeNoFilter by scope: "reservable" (student sign-ups) or "manageable" (instructor-owned)
includeNoExtra data to include: appointments (time slots), child_events (per-slot reservations), participant_count
context_codesNoLimit to specific contexts, e.g. ["course_123"]

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.18.11
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Addedv1.18.4

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnlyHint and openWorldHint. The description adds important behavior: pagination fetches every page at 100 per request, fails with a 'Results are incomplete' error instead of truncating, and certain fields are omitted unless include values are passed. This goes well beyond the safety profile already in annotations.

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?

The purpose and scope default are front-loaded, and each sentence adds useful information. It is slightly dense but not padded; a small amount of tightening could improve it without losing content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/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 sufficiently covers return fields, pagination and error behavior, scope semantics, and alternatives. An agent has enough information to call the tool correctly and understand limitations.

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%, so the baseline is 3. The description adds value by explaining the default scope value, the two scope meanings, and that time slots, per-slot reservations, and participant counts are omitted unless the matching include value is passed.

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 states a specific verb and resource ('List appointment groups (Canvas Scheduler sign-up slots)') and enumerates the returned fields, so an agent can distinguish this from sibling tools such as get_appointment_group and next_appointment without opening the schema.

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?

It explicitly gives the default scope ('reservable'), explains the alternative ('manageable'), and routes the agent to get_appointment_group or next_appointment when those are more appropriate. It also clarifies that reserving a slot is not possible through this server.

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