Skip to main content
Glama

canvas_appointment_group

Read-onlyIdempotent

Retrieve a Canvas appointment group with its available time slots and your reservations, so you can check office hours or demo sign-ups before booking.

Instructions

Read one appointment group (sign-up slots a teacher offers, such as office hours or demos) with its available time slots and your reservations.

Input Schema

NameRequiredDescriptionDefault
rawNotrue: Canvas's unmodified JSON (UTC times, HTML).
pageNoPage to fetch: a number, or the next_page value returned by the previous call.
appointment_group_idYesAppointment group id, from canvas_appointment_groups.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and a closed-world scope, so the safety profile is covered. The description adds genuine value by saying what comes back — available time slots and 'your reservations' — but says nothing about pagination behavior despite the 'page' parameter or about the raw/HTML variant.

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?

A single front-loaded sentence with no filler: verb, resource, gloss, and returned data in order of importance. The parenthetical is short and genuinely clarifying rather than padding.

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 low-complexity single-resource read with full schema coverage, the description covers purpose and return contents, which substitutes for the absent output schema. Minor gap: no hint that results are paginated or how to page through, which would matter for large groups.

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 inline (including the raw JSON toggle and the page/bookmark pattern), so the schema carries the parameter burden. The description adds no format or semantics beyond that, making the baseline 3 appropriate.

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 and resource ('Read one appointment group') and glosses the domain concept ('sign-up slots a teacher offers, such as office hours or demos'). The singular 'one' contrasted with the sibling list tool 'canvas_appointment_groups' lets an agent pick correctly without opening either schema.

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 by 'one' versus the plural listing sibling, but the description never states when to use this instead of canvas_appointment_groups, nor any prerequisite (e.g. needing an id obtained from the list tool). No when-not guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.