Skip to main content
Glama
Sign In
Canvas LMS MCP Server

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Delete Appointment Group

delete_appointment_group
Destructive

Permanently delete an appointment group and cancel all its time slots and reservations, notifying every signed-up participant by email, with an optional cancellation reason.

Instructions

Delete an appointment group by id, canceling every time slot and reservation on it and emailing every signed-up participant, then return the deleted group object. This is permanent: the group and its slots cannot be recovered afterward. Pass cancel_reason to include why in that cancellation email. Find the id with list_appointment_groups, and check list_appointment_group_users or list_appointment_group_groups first if you need to know who will be notified. Requires permission to manage the Scheduler in the group's context.

Input Schema

NameRequiredDescriptionDefault
cancel_reasonNoMessage to include in cancellation notifications
appointment_group_idYesThe appointment group ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.18.15
    • addedInput schema / properties / appointment_group_id / anyOf
      Added value: +[
+  {
+    "exclusiveMinimum": 0,
+    "maximum": 9007199254740991,
+    "type": "integer"
+  },
+  {
+    "pattern": "^[1-9][0-9]{0,18}$",
+    "type": "string"
+  }
+]
    • removedInput schema / properties / appointment_group_id / type
      Removed value: -"number"
  2. 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"
  3. Addedv1.18.4

TDQS

A4.9/5.0
Behavior5/5

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

Annotations declare destructiveHint=true and openWorldHint=true, but the description goes well beyond: it discloses the exact blast radius (all time slots and reservations canceled, every signed-up participant emailed), irreversibility ('cannot be recovered afterward'), and the required permission scope ('manage the Scheduler in the group's context'). It also states the return value (deleted group object).

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?

Four sentences, each carrying distinct load: action+side effects, irreversibility, parameter note, prerequisite lookup, and permission. The destructiveness warning is front-loaded before the parameter and lookup guidance.

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?

For a destructive, side-effecting tool with no output schema, the description covers what gets destroyed, who gets notified, reversibility, auth requirements, how to find the id, and the return value. Nothing an agent needs before calling is missing.

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 baseline is 3; the description adds marginal value on cancel_reason (it lands in the cancellation email to participants) and useful guidance on how to obtain appointment_group_id. It does not clarify the integer-or-string ID union, but the schema covers that.

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?

States a specific verb+resource ('Delete an appointment group by id') and immediately enumerates the cascade (slots, reservations) and return value. Clearly distinct from sibling update_appointment_group and get_appointment_group, and from delete_assignment/delete_rubric by naming the exact resource.

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?

Explicitly routes the agent: 'Find the id with list_appointment_groups' and 'check list_appointment_group_users or list_appointment_group_groups first if you need to know who will be notified.' Both the prerequisite lookup tool and the conditional pre-check tool are named.

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