Skip to main content
Glama

Read a class syllabus (Canvas)

read_syllabus
Read-onlyIdempotent

Reads a course's Canvas syllabus page and syllabus PDFs as plain text to find exam dates and details missing from deadline lists. Set refresh for current Canvas data.

Instructions

Read a class's syllabus from the user's Canvas: the syllabus page plus syllabus PDFs (linked from it, or named "syllabus" in the course's Files), as plain text. course is a course number or part of its name ("21-127", "linear"). Useful when exam dates aren't in whats_due, since many teachers only put them in the syllabus. Read-only. refresh: true asks Canvas right now instead of using answers saved in the last few minutes (deadlines), day (class list) or week (syllabus); use it when the person says something was just posted or changed.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "course": "<course>"
    },
    "name": "read_syllabus"
  }
}

Input Schema

NameRequiredDescriptionDefault
courseYes
refreshNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuinely new behavior: results are served from cached answers with different TTLs per data type (minutes for deadlines, a day for the class list, a week for syllabus), and `refresh: true` bypasses that cache. It does not say what happens when no syllabus or PDF exists, which keeps it short of a 5.

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?

Purpose and scope come first, then the alternative-tool note, then parameter guidance — a sound front-loaded order with no filler sentences. The final `refresh` sentence is long and stacks three parenthetical TTLs, which slightly hurts scannability.

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?

An output schema exists, so return format needn't be explained; the description instead covers the things an agent could otherwise get wrong — where syllabus content can come from, plain-text form, and cache staleness. For a two-parameter read tool this is complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must carry the load and does: `course` accepts a course number or partial name, with worked examples ("21-127", "linear"), and `refresh` is given both meaning and a triggering condition plus the stale-window it overrides. This is meaning well beyond the bare string/boolean schema.

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 a class's syllabus from the user's Canvas") and enumerates the exact scope: the syllabus page plus syllabus PDFs, either linked from the page or named "syllabus" in the course Files, returned as plain text. It also distinguishes itself from a sibling by noting it is useful when exam dates aren't in `whats_due`.

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?

Names the concrete situation that selects this tool over `whats_due` (exam dates that only appear in the syllabus) and gives an explicit condition for the `refresh` parameter (person says something was just posted or changed). The when-to-use path is unambiguous rather than inferred.

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