Skip to main content
Glama

Course snapshot

canvas_course_snapshot
Read-only

Retrieve a compact stored course snapshot without calling Canvas. Filter by kinds (pages, modules, assignments, etc.) to get deadlines, grades, and course content.

Instructions

The stored state of a course from the latest snapshot (no Canvas calls), compact. Use kinds (page, module, assignment, announcement, discussion, quiz, event, syllabus, file) to keep it small, e.g. ["assignment"] for all deadlines and grades.

Input Schema

NameRequiredDescriptionDefault
kindsNo
course_idYes
text_charsNoChars of page/description text per item, default 300

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description's one real addition is "no Canvas calls" — implying local cached reads — but it never says how stale the snapshot can be or how it relates to canvas_run_snapshot refreshing it, which is the key behavioral caveat for a cache-read tool.

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?

Two sentences, zero filler, with the most decision-relevant fact ("no Canvas calls") and the compactness trade-off front-loaded. Every clause carries information the agent can act on.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 3-parameter read tool with annotations present and no output schema, the description is serviceable but thin: it never characterizes the return shape beyond "compact", doesn't explain how text_chars truncation manifests, and doesn't mention staleness or how a snapshot is refreshed. An agent can call it, but not fully predict what it receives.

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 only 33% (text_chars alone is documented), so the description does real work: it enumerates the kinds vocabulary and gives a concrete example ("["assignment"] for all deadlines and grades") that explains intent, not just the allowed strings. It does not clarify course_id's expected format, which is the main remaining gap.

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 resource and scope: the stored/cached state of one course from the latest snapshot, explicitly "(no Canvas calls)". This differentiates it from live-fetch siblings like canvas_list_assignments, though it never names those siblings directly, so the differentiation must be inferred from the parenthetical.

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 only guidance is about parameter usage ("Use kinds ... to keep it small"), not about when to choose this over canvas_list_assignments or canvas_run_snapshot. Nothing tells the agent when the cached snapshot is preferable (speed?) versus when freshness requires a live call.

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