Skip to main content
Glama
bruchris

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Create Appointment Group

create_appointment_group
Destructive

Create appointment groups for Canvas Scheduler with title, context, and time slots. Configure publishing, participant limits, and visibility to manage sign-ups.

Instructions

Create a new appointment group (sign-up slots) in Canvas Scheduler. Provide at least one context_code (e.g. "course_123") and a title. Add new_appointments as [start_at, end_at] pairs to define time slots.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesTitle of the appointment group
publishNoIf true, publish immediately (default: false = draft)
descriptionNoOptional description
context_codesYesContexts to associate with this group, e.g. ["course_123"]
location_nameNoLocation name
location_addressNoLocation address
new_appointmentsNoTime slots to create as [start_at, end_at] pairs (ISO 8601 strings)
participant_typeNoWhether individuals (User) or groups (Group) sign up. Default: User
participant_visibilityNoWho can see other sign-ups: "private" (instructors only) or "protected" (all participants)
max_appointments_per_participantNoMaximum time slots each participant can reserve
min_appointments_per_participantNoMinimum time slots each participant must reserve

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. Changed3 schema fields changedv1.18.5
    • changedInput schema / properties / new_appointments / items / items
      Previous value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "string"
-  }
-]New value: +{
+  "type": "string"
+}
    • addedInput schema / properties / new_appointments / items / maxItems
      Added value: +2
    • addedInput schema / properties / new_appointments / items / minItems
      Added value: +2
  3. Addedv1.18.4

TDQS

A3.8/5.0
Behavior4/5

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

Annotations indicate destructiveHint: true, and the description aligns by noting creation action, though it doesn't detail irreversible effects or permission requirements. It clarifies that new_appointments define time slots and mentions the default draft behavior implicitly through the publish parameter. The description adds value by specifying the structure of new_appointments, which is not fully in the schema, but it doesn't disclose any potential side effects or prerequisites beyond what's in the schema.

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?

The description is concise, two sentences, and front-loads the core purpose and required attributes. It efficiently communicates the essential usage without redundant detail, earning a high score.

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 an 11-parameter tool with no output schema, the description covers the essentials: required fields, the salient new_appointments format, and hints at the draft/publish behavior via the publish parameter. However, it doesn't mention return behavior or error cases, and doesn't detail all optional parameters, but given the schema's richness, it is reasonably complete for an agent to invoke 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%, so parameters like context_codes and title are already well-documented. The description reinforces the required parameters and provides an example of context_code format ('course_123') and new_appointments structure, which adds a bit more clarity. However, it doesn't explain optional parameters like participant_type or max_appointments_per_participant beyond what the schema already states.

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 clearly states the tool creates a new appointment group in Canvas Scheduler)Skip, with specific details about required parameters (context_code and title) and new_appointments as [start_at, end_at] pairs. It distinguishes from siblings like list_appointment_groups and update_appointment_group by focusing on creation, but doesn't explicitly name a sibling or contrast with other creation tools like create_calendar_event.

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?

The description gives some usage context (e.g., provide at least one context_code and a title) but does not explicitly state when to use this tool versus alternatives like create_calendar_event or list_appointment_groups. It implies it's for setting up sign-up slots in Canvas Scheduler, but no direct comparison or exclusion of alternatives is provided.

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