Prototype · Preview: every server in the official registry, synced every 30 minutes. Sign in with Google to write reviews.Prototype · updated every 30 min
PopNx MCPMCP servers for people who use AI · explained in plain words Sign in

Canvas LMS (read-only)

by rbrtlolversion 2.2.1i★ 0iRuns on your computerRepository ↗
Registry nameio.github.rbrtlol/canvas-readonly-mcp

How to install

What it does

Read-only Canvas LMS for students: what changed in your courses, search across slides and PDFs.

  • Connects Runs on your computer
  • Account or key Needs CANVAS_TOKEN · 1 setting to fill in (CANVAS_BASE_URL)
  • Category Games, sports, food & learning

Why it ranks here

Lists are ordered by a usage score (out of 100) built from these parts

Popularity0/80GitHub stars or weekly downloads: the larger counts 60, the smaller 20
Freshness12/12Full marks for a release or code change within 30 days
Still answering0/8The cloud endpoint answered at the last check
Usage score12/100

Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)

Install

Pick the AI app you use, then copy the settings.

Let your AI install it with one sentence

Please install Canvas LMS (read-only). Follow https://mcp.popnx.com/i/rbrtlol-canvas-readonly-mcp.md, show me the commands and wait for my OK before running them.

Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads

Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 14, 2026

First: which AI do you use?

Pick your app and the steps appear below.

Works with Claude, with some setup first

You need a Canvas LMS (read-only) key (create it on the maker’s site) · 1 setting(s) to fill in (CANVAS_BASE_URL) · Only the Claude desktop app (Windows or Mac), not the web or phone

  1. Download the maker’s installer

    Download the maker’s .mcpb file

    The .mcpb file comes straight from the maker; we do not change it

  2. Double-click the file, then click Install in the Claude desktop app

  3. Try it

    Use Canvas LMS (read-only) and tell me what you can do for me, then show me one thing

    ✓ If Claude says it is using Canvas LMS (read-only) or shows a Canvas LMS (read-only) tool in the answer, you are connected

1 optional setting(s) (works without them)

The command above works without these. Add them only if you want to change something, following the maker’s description.

  • CANVAS_HOST_ALIASES Other hostnames of the same Canvas, comma-separated (optional)

Descriptions are as written by the maker.

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

ChatGPT cannot connect Canvas LMS (read-only) yet

Canvas LMS (read-only) runs on your computer, but ChatGPT can only connect servers that run on the web

What you can do instead

A · Use an app that can connect Canvas LMS (read-only)

  • You need a Canvas LMS (read-only) key (create it on the maker’s site) · 1 setting(s) to fill in (CANVAS_BASE_URL) · Only the Claude desktop app (Windows or Mac), not the web or phone
  • You need a Canvas LMS (read-only) key (create it on the maker’s site) · 1 setting(s) to fill in (CANVAS_BASE_URL) · Install Node.js on your computer first (one time)
  • You need a Canvas LMS (read-only) key (create it on the maker’s site) · 1 setting(s) to fill in (CANVAS_BASE_URL) · Install Node.js on your computer first (one time)
  • You need a Canvas LMS (read-only) key (create it on the maker’s site) · 1 setting(s) to fill in (CANVAS_BASE_URL) · Install Node.js on your computer first (one time)

B · Others in Games, sports, food & learning that work with ChatGPT

Picked from the most used in the same category, only ones that connect by address with no key

Works with Claude Code, with some setup first

You need a Canvas LMS (read-only) key (create it on the maker’s site) · 1 setting(s) to fill in (CANVAS_BASE_URL) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Canvas LMS (read-only) for Claude Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user canvas-readonly --env CANVAS_BASE_URL=your-value --env CANVAS_TOKEN=your-value -- npx -y canvas-readonly-mcp 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For CANVAS_TOKEN, CANVAS_BASE_URL, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Canvas LMS (read-only) tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a Canvas LMS (read-only) key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the Canvas LMS (read-only) site ↗

  3. Fill in 1 setting(s)

    These are program settings, not keys. No sign-up needed; fill them in as the maker describes.

    • CANVAS_BASE_URL Your Canvas address, e.g. https://canvas.yourschool.edu

    Descriptions are as written by the maker.

  4. Open Terminal

    Mac: press Command+Space and type Terminal · Windows: open PowerShell

  5. Paste this command and press Enter

    claude mcp add --scope user canvas-readonly --env CANVAS_BASE_URL=your-value --env CANVAS_TOKEN=your-value -- npx -y canvas-readonly-mcp

    Replace “your-value” with your key before pressing Enter

    Paste the key only into the app’s field, never into a chat or to anyone

  6. Type /mcp in Claude Code

    You should see Canvas LMS (read-only) listed as connected

  7. Try it

    Use Canvas LMS (read-only) and tell me what you can do for me, then show me one thing

    ✓ If Claude Code says it is using Canvas LMS (read-only) or shows a Canvas LMS (read-only) tool in the answer, you are connected

1 optional setting(s) (works without them)

The command above works without these. Add them only if you want to change something, following the maker’s description.

  • CANVAS_HOST_ALIASES Other hostnames of the same Canvas, comma-separated (optional)

Descriptions are as written by the maker.

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with Cursor, with some setup first

You need a Canvas LMS (read-only) key (create it on the maker’s site) · 1 setting(s) to fill in (CANVAS_BASE_URL) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Canvas LMS (read-only) for Cursor on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "canvas-readonly": { "command": "npx", "args": [ "-y", "canvas-readonly-mcp" ], "env": { "CANVAS_BASE_URL": "your-value", "CANVAS_TOKEN": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For CANVAS_TOKEN, CANVAS_BASE_URL, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Canvas LMS (read-only) tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a Canvas LMS (read-only) key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the Canvas LMS (read-only) site ↗

  3. Fill in 1 setting(s)

    These are program settings, not keys. No sign-up needed; fill them in as the maker describes.

    • CANVAS_BASE_URL Your Canvas address, e.g. https://canvas.yourschool.edu

    Descriptions are as written by the maker.

  4. Click this button to open Cursor

    Open in Cursor

    Cursor asks you to confirm; click Install

  5. Fill in your key

    In the Canvas LMS (read-only) settings, CANVAS_TOKEN, CANVAS_BASE_URL is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  6. Open the AI chat in Cursor in Agent mode

  7. Try it

    Use Canvas LMS (read-only) and tell me what you can do for me, then show me one thing

    ✓ If Cursor says it is using Canvas LMS (read-only) or shows a Canvas LMS (read-only) tool in the answer, you are connected

1 optional setting(s) (works without them)

The command above works without these. Add them only if you want to change something, following the maker’s description.

  • CANVAS_HOST_ALIASES Other hostnames of the same Canvas, comma-separated (optional)

Descriptions are as written by the maker.

Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with VS Code, with some setup first

You need a Canvas LMS (read-only) key (create it on the maker’s site) · 1 setting(s) to fill in (CANVAS_BASE_URL) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Canvas LMS (read-only) for VS Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "canvas-readonly": { "type": "stdio", "command": "npx", "args": [ "-y", "canvas-readonly-mcp" ], "env": { "CANVAS_BASE_URL": "your-value", "CANVAS_TOKEN": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For CANVAS_TOKEN, CANVAS_BASE_URL, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Canvas LMS (read-only) tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a Canvas LMS (read-only) key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the Canvas LMS (read-only) site ↗

  3. Fill in 1 setting(s)

    These are program settings, not keys. No sign-up needed; fill them in as the maker describes.

    • CANVAS_BASE_URL Your Canvas address, e.g. https://canvas.yourschool.edu

    Descriptions are as written by the maker.

  4. Click this button to open VS Code

    Open in VS Code

    VS Code asks you to confirm; click Install

  5. Fill in your key

    In the Canvas LMS (read-only) settings, CANVAS_TOKEN, CANVAS_BASE_URL is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  6. Open the AI chat in VS Code in Agent mode

  7. Try it

    Use Canvas LMS (read-only) and tell me what you can do for me, then show me one thing

    ✓ If VS Code says it is using Canvas LMS (read-only) or shows a Canvas LMS (read-only) tool in the answer, you are connected

1 optional setting(s) (works without them)

The command above works without these. Add them only if you want to change something, following the maker’s description.

  • CANVAS_HOST_ALIASES Other hostnames of the same Canvas, comma-separated (optional)

Descriptions are as written by the maker.

Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.

See every app that uses MCP →

JSON settings are under “For developers” below

Stuck? Ask people who use Canvas LMS (read-only)💬 Discussion →
For developers: Terminal commands and JSON settings

Installed on your computer

Claude Code

claude mcp add --scope user canvas-readonly --env CANVAS_BASE_URL=your-value --env CANVAS_TOKEN=your-value -- npx -y canvas-readonly-mcp

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "canvas-readonly": {
      "command": "npx",
      "args": [
        "-y",
        "canvas-readonly-mcp"
      ],
      "env": {
        "CANVAS_BASE_URL": "your-value",
        "CANVAS_TOKEN": "your-value"
      }
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "canvas-readonly": {
      "command": "npx",
      "args": [
        "-y",
        "canvas-readonly-mcp"
      ],
      "env": {
        "CANVAS_BASE_URL": "your-value",
        "CANVAS_TOKEN": "your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "canvas-readonly": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "canvas-readonly-mcp"
      ],
      "env": {
        "CANVAS_BASE_URL": "your-value",
        "CANVAS_TOKEN": "your-value"
      }
    }
  }
}

Values you fill in

  • CANVAS_BASE_URL required env
    Your Canvas address, e.g. https://canvas.yourschool.edu
  • CANVAS_TOKEN secret required env
    Canvas personal access token (Account → Settings → New access token)
  • CANVAS_HOST_ALIASES env
    Other hostnames of the same Canvas, comma-separated (optional)

Descriptions are as written by the maker.

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

At a glance

Downloads per weeki
82/wk
Connection
Runs on your computer
Latest versioni
2.2.1
Published to registryi
Nov 12, 2026
Code last changedi
Nov 13, 2026
Maker
rbrtlol
Packages
npm: canvas-readonly-mcp
mcpb: …/canvas-readonly-mcp-2.2.1.mcpb
Website
github.com
Registry status
Active

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Run on your computer in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

All apps, with pros and cons →

Related guides

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 20, 2026

  • ✓ Pass

    Maker matches the repo

    The registry name was verified with the GitHub account rbrtlol, which owns the repo

  • ✓ Pass

    Still maintained

    Code last changed 7 days ago

  • ✓ Pass

    Has a licence

    Uses MIT

  • – Not applicable

    Endpoint responds

    This one runs on your computer; there is no internet endpoint

  • – Not applicable

    Sign-in with OAuth

    Runs on your computer and uses local settings instead

  • … Not checked yet

    No hidden instructions in tool descriptions

    Runs on your computer; we can only read tool lists from internet endpoints

Published vulnerabilities (OSV.dev)

No entries on OSV.dev for canvas-readonly-mcp@2.2.1

Checks only this package version, not every dependency · checked Nov 16, 2026

What we check → · JSON

Makers: ask for a re-check or report wrong info
For makers: add a badge to your README

If you made this, paste this code into your README. The badge links back to this page.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/rbrtlol-canvas-readonly-mcp.svg)](https://mcp.popnx.com/en/servers/rbrtlol-canvas-readonly-mcp)

Discussion

Ask, share a tip or report that it does not work. Sorted by what people marked helpful.

No posts yet. Be the first to ask or share.

Posts here are written by users, not the PopNx team.

Sign in to post

User reviews

No reviews yet

Sign in to write a review

Compared with others in Games, sports, food & learningi

  • More stars than 0% of the other 1683 servers in this category
  • Published to the registry more recently than 80% of the other 1683 servers in this category
  • Basic checks equal to or better than 99% of the other 1683 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is Canvas LMS (read-only) safe?

It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: CANVAS_TOKEN

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed 7 days ago, and the latest version (2.2.1) reached the registry 8 days ago.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Node.js, MCPB on your computer.

What can I use instead?

In the same category: LearnHouse, Anime Garden, WilmAI, Lumify Sports Intelligence, Savecraft

Similar alternatives

Same category, other makers, commands already checked. Official ones first, then by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

LearnHouse

Build, edit and run courses, learning paths and communities in your LearnHouse academy.

by learnhouseWidely used★ 2.5KUpdated yesterday

Runs in the cloud✓ service owner · learnhouse.app

WilmAI

Finland's Wilma school system for parents and students: schedule, homework, exams and messages.

by aikarjalGrowing↓ 1.4K/wk★ 89 Stars for the whole repoUpdated 11 days ago

Runs on your computer✓ service owner · wilm.ai

Savecraft

Savecraft serves real save game data and expert game knowledge to AI assistants.

by joshsymondsEarly★ 13Updated 7 months ago

Runs in the cloudRepo archived✓ service owner · savecraft.gg
Compared with similar ones
This one
Canvas LMS (read-only)
LearnHouseAnime GardenWilmAILumify Sports IntelligenceSavecraft
Runs whereInstalls on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to installInstalls on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to install
Needs a keyYesNoNoNoYesNo
Add with + in ClaudeNoNoNoNoNoNo
Basic checks3/35/54/43/34/43/4
LicenseMITAGPL-3.0AGPL-3.0MITMITApache-2.0
PriceNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registry

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

canvas-readonly-mcp

Ask Claude what changed in your courses, and search every lecture slide. A read-only MCP server for Canvas LMS, built as a study assistant rather than a full Canvas API.

  • Knows what changed: daily snapshots of your courses, so "what's new since yesterday?" is one call: new announcements, moved deadlines, new grades, edited pages, even which slides in a lecture PDF changed.
  • Searches inside your files: full-text search over pages, assignments, announcements and the text of every linked PDF, slide deck and document, with the page or slide number. It finds files linked from pages and modules even when the Files tab is hidden.
  • Read-only by design: it only ever sends GET requests to Canvas. It can't submit, post, grade or change anything, and it doesn't even mark discussions as read.
  • Your token stays with you: one-click Claude Desktop extension (token in your system keychain), local stdio, or your own server for claude.ai. Nothing goes through a third party.

Works with any Canvas instance. Made for students; TAs and teachers can use it too (for reading, e.g. "needs grading" counts).

Not affiliated with or endorsed by Instructure. "Canvas" is a trademark of Instructure, Inc.

What you can ask

  • "What changed in my courses since yesterday?"
  • "What's due in the next two weeks, and what have I not submitted?"
  • "Summarize the lab 2 instructions" (the server finds the PDF linked from the course and returns its text)
  • "Which slides in lecture 5 changed since last week?"
  • "Where did we cover dynamic programming?" (searches pages, announcements and the text of every linked PDF and slide deck)
  • "How will lab 3 be graded, and what did I lose points on in lab 2?"

Tools

ToolWhat it's for
canvas_changes_sinceWhat changed since a time (default 26h): new/changed pages, assignments (due dates, grades), announcements, discussions, quizzes, events, files (which PDF pages changed). The daily-check tool.
canvas_searchFull-text search across your courses: pages, assignments, announcements, discussions, the syllabus, and the text of linked PDFs, slides and documents (with the page/slide number). From stored snapshots, so it's instant.
canvas_course_snapshotStored state of a course (optionally only some kinds, e.g. assignments). No Canvas calls.
canvas_snapshot_statusSnapshot health: courses and your role, last run, counts, errors, next run.
canvas_run_snapshotTake a snapshot now and return what changed.
canvas_whoamiThe Canvas user the token belongs to; checks that the connection works.
canvas_list_coursesYour courses, ids and your role in each.
canvas_whats_newCanvas's own activity stream since a time, including inbox messages. Live, but doesn't see edits, removals or file changes like canvas_changes_since does.
canvas_list_planner_itemsEverything dated in a window, with submission status.
canvas_list_assignments / canvas_get_assignmentAssignments, due dates, descriptions, rubrics; as a student also your submission, teacher comments and rubric scores. "Needs grading" counts for TAs/teachers.
canvas_list_quizzes / canvas_get_quizClassic quizzes and New Quizzes: time limit, attempts, lock window, instructions, your latest attempt.
canvas_list_announcementsAnnouncements across courses.
canvas_list_discussions / canvas_get_discussionDiscussion topics, and a whole thread with replies (without marking anything read).
canvas_get_syllabusThe syllabus page.
canvas_list_modulesModule structure with items.
canvas_list_pages / canvas_get_pageCourse pages as text, with their file links.
canvas_list_linked_filesEvery file linked from the course (front page, pages, modules, assignments, announcements). Works even when the files tab is hidden.
canvas_list_filesThe full Files area, including unlinked files (mostly for TAs/teachers); falls back to linked files when your role can't list it.
canvas_read_fileText of a PDF (per page), PPTX (per slide + notes), DOCX (per section), text/code file, or ZIP listing. Takes a file id or any Canvas file URL; supports page ranges.
canvas_list_calendar_eventsCalendar events.
canvas_get_gradesYour own scores, grades and comments (as a student).
canvas_api_getEscape hatch: any GET /api/v1/... endpoint (can be disabled).

Quick start

1. Get a Canvas access token

In Canvas: Account → Settings → + New access token. Give it a purpose ("Claude") and preferably an expiry date.

You also need your Canvas address, e.g. https://canvas.yourschool.edu or https://yourschool.instructure.com.

No "New access token" button? Your school may have turned personal tokens off.

Some institutions disable personal access tokens for students, or only allow short-lived ones. This server needs one: it doesn't support Canvas OAuth, because that requires your school's admins to register each app.

  • Button missing: ask your school's Canvas or IT support whether personal access tokens can be enabled for you. Mention that it's for a tool that only reads (it never sends anything but GET requests). Some schools say yes, many say no.
  • Token expires quickly: tools start failing with "the Canvas API token is invalid or expired". Create a new token and update it: in Claude Desktop under Settings → Extensions → Canvas LMS (read-only), or CANVAS_TOKEN in your config or .env.
  • Check your school's rules on connecting course data to AI tools before you start.
2a. Claude Desktop: one-click extension (easiest)
  1. Download canvas-readonly-mcp- .mcpb from the latest release.
  2. Open it (double-click, or drag it into Claude Desktop → Settings → Extensions) and click Install.
  3. Enter your Canvas address and access token. The token is stored in your system keychain.

Nothing else to install: Claude Desktop runs the extension with its built-in Node.js.

2b. Local: Claude Code and other stdio clients

Requires Node.js 22.13 or newer.

Claude Code:

claude mcp add canvas \

-e CANVAS_BASE_URL=https://canvas.yourschool.edu \ -e CANVAS_TOKEN=your-token \ -- npx -y canvas-readonly-mcp

Claude Desktop without the extension: add this to claude_desktop_config.json (Settings → Developer → Edit Config):

{

"mcpServers": { "canvas": { "command": "npx", "args": ["-y", "canvas-readonly-mcp"], "env": { "CANVAS_BASE_URL": "https://canvas.yourschool.edu", "CANVAS_TOKEN": "your-token" } } } }

In stdio mode, snapshots refresh shortly after the client starts the server, and in the background whenever they're older than SNAPSHOT_MAX_AGE_H (default 20h). Data is stored in your user data directory (~/Library/Application Support/canvas-readonly-mcp on macOS, ~/.local/share/canvas-readonly-mcp on Linux, %APPDATA%\canvas-readonly-mcp on Windows).

2c. Server: claude.ai custom connectors (HTTP)

claude.ai connects from the internet, so this needs a server with HTTPS.

mkdir canvas-mcp && cd canvas-mcp

curl -O https://raw.githubusercontent.com/rbrtlol/canvas-readonly-mcp/main/docker-compose.yml curl -o .env https://raw.githubusercontent.com/rbrtlol/canvas-readonly-mcp/main/.env.example

Fill in CANVAS_BASE_URL and CANVAS_TOKEN, then:

sed -i "s/^MCP_SECRET=.*/MCP_SECRET=$(openssl rand -hex 32)/" .env chmod 600 .env docker compose up -d curl -s localhost:8787/healthz # {"ok":true}

Put a reverse proxy with TLS in front of it: deploy/Caddyfile.example (automatic certificates) or deploy/nginx.conf.example. In claude.ai, add a custom connector with the URL

https://canvas-mcp.example.com/mcp/<MCP_SECRET>

and leave the OAuth fields empty. Clients that support headers can use https://…/mcp with Authorization: Bearer instead.

Without Docker: npx canvas-readonly-mcp --http --env-file .env.

Configuration

All settings are environment variables (or a file passed with --env-file).

VariableDefaultMeaning
CANVAS_BASE_URLrequiredYour Canvas address.
CANVAS_TOKENrequiredPersonal access token.
MCP_SECRETrequired for --httpAt least 32 characters; part of the connector URL.
CANVAS_HOST_ALIASESOther hostnames of the same Canvas, comma-separated (e.g. yourschool.instructure.com when you use a custom domain). Links to them are recognized.
DISPLAY_TZyour Canvas profile'sTime zone for displayed times (IANA name, e.g. Europe/Stockholm).
ENABLE_RAW_GETtrueSet false to remove canvas_api_get.
HOST / PORT127.0.0.1 / 8787HTTP listen address (0.0.0.0 in the Docker image).
DATA_DIROS user data dirWhere the database and cache live. DB_PATH / CACHE_DIR override each.
SNAPSHOT_ENABLEDtrueTurn the snapshot/change-log feature off entirely.
SNAPSHOT_COURSESOnly these course ids (overrides SNAPSHOT_SCOPE). id:label:role overrides the label and role.
SNAPSHOT_SCOPEdashboardWhich courses to snapshot: dashboard = the courses on your Canvas dashboard (your favorites, or Canvas's automatic pick if you haven't chosen any); active = every active enrollment. Courses whose end date has passed are skipped either way.
SNAPSHOT_EXCLUDECourse ids to skip.
SNAPSHOT_AT04:30Daily snapshot time in DISPLAY_TZ, or off.
SNAPSHOT_MAX_AGE_H20Refresh at startup / on demand when older than this.
SNAPSHOT_EXTRACTlinkedWhich files' text to hash for change detection: linked, all (also files only in the files index), none.
EVENT_RETENTION_DAYS120How long change events are kept.
CRAWL_MAX_PAGES / ANNOUNCEMENT_DAYS200 / 730Crawl limits per course.
MAX_FILE_MB / DOWNLOAD_TIMEOUT_S50 / 60Download limits.
EXTRACT_TIMEOUT_S / EXTRACT_MAX_PAGES60 / 500Text extraction limits.
CACHE_MAX_MB500Extracted-text cache size; least recently used entries are evicted.

How it works

Finding files. Many Canvas setups hide the files and pages lists from students. The server therefore uses those lists when your role may see them, and otherwise follows links from the front page, modules, syllabus, assignments and announcements. canvas_get_page shows file links inline as (file: ). Leftover $CANVAS_OBJECT_REFERENCE$ links from course copies are resolved where possible and otherwise marked as broken.

Reading files. canvas_read_file downloads the file (the token is only sent to Canvas itself, never to the storage host it redirects to) and extracts text in a separate worker thread with memory and time limits. Results are cached by file id and updated_at. Scanned PDFs without a text layer are reported as such (no OCR). Legacy .doc/.ppt aren't supported.

Snapshots and the change log. Once a day (and when stale), the server stores the state of each course on your Canvas dashboard in SQLite (star a course under *Courses → All courses* to add it, or set SNAPSHOT_COURSES): pages, modules, assignments (with your submission status and grade), announcements and discussions (with a teacher/TA flag), quizzes, calendar events, the syllabus, and file metadata with a per-page content hash for PDFs. Each item is normalized (HTML to text, volatile fields dropped) and hashed. Differences become change events with old → new values, short text diffs, and changed PDF page numbers. The first run is a silent baseline. Announcements with no posted_at (copied from an earlier

Only the beginning is shown; read the rest in the repo