mcpField
C
canvas-parent-mcp

canvas-parent-mcp

Local
github.com/chrischallScience & Education0Updated 3d ago

About canvas-parent-mcp

canvas-parent-mcp is an unofficial MCP server for parent observers and students accessing their own Canvas LMS data. Its read-focused tools cover courses, assignments, grades, schedules, messages and files, with several authentication options including a browser-session fallback.

Key features

  1. 01Read profiles and observed accounts
  2. 02Browse courses, assignments and submissions
  3. 03Check grades, calendar and planner items
  4. 04Read announcements, conversations and discussions
  5. 05List course files and download files
  6. 06Token, OAuth, password or browser-session authentication

Use cases

  1. 01Check a student's missing assignments and recent submissions
  2. 02Review grades and upcoming course events
  3. 03Read course announcements or conversations
  4. 04Retrieve a course file to a local download directory

MCP support

Exposes Canvas LMS data through MCP tools, primarily for read access; file downloads are also available. It authenticates to the configured Canvas instance using one of its supported modes.

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
"mcpServers": {
"chrischall-canvas-parent": {
"command": "npx",
"args": [
"-y",
"canvas-parent-mcp"
],
"env": {
"CANVAS_BASE_URL": "<CANVAS_BASE_URL>",
"CANVAS_USERNAME": "<CANVAS_USERNAME>",
"CANVAS_PASSWORD": "<CANVAS_PASSWORD>",
"CANVAS_TOKEN": "<CANVAS_TOKEN>",
"CANVAS_CLIENT_ID": "<CANVAS_CLIENT_ID>",
"CANVAS_CLIENT_SECRET": "<CANVAS_CLIENT_SECRET>",
"CANVAS_REFRESH_TOKEN": "<CANVAS_REFRESH_TOKEN>",
"CANVAS_NAME": "<CANVAS_NAME>",
"CANVAS_SESSION_CACHE": "<CANVAS_SESSION_CACHE>",
"CANVAS_SESSION_FILE": "<CANVAS_SESSION_FILE>",
"CANVAS_OUTPUT_DIR": "<CANVAS_OUTPUT_DIR>",
"CANVAS_DISABLE_FETCHPROXY": "<CANVAS_DISABLE_FETCHPROXY>",
"FETCHPROXY_WS_PORT": "<FETCHPROXY_WS_PORT>",
"FETCHPROXY_WS_HOST": "<FETCHPROXY_WS_HOST>",
"FETCHPROXY_IDENTITY_DIR": "<FETCHPROXY_IDENTITY_DIR>"
}
}
}
}
Run commandnpx -y canvas-parent-mcp
Environment variables to set
CANVAS_BASE_URLCanvas instance base URL, e.g. https://cms.instructure.com
CANVAS_USERNAMECanvas login username/email (recommended) — pair with CANVAS_PASSWORD for auto-login. No SSO/2FA.
CANVAS_PASSWORDSecretCanvas password (recommended) — required iff CANVAS_USERNAME is set
CANVAS_TOKENSecretCanvas personal access token (advanced) — most schools have disabled token creation
CANVAS_CLIENT_IDCanvas OAuth client ID (advanced — for SSO accounts that can't use username/password)
CANVAS_CLIENT_SECRETSecretCanvas OAuth client secret (advanced)
CANVAS_REFRESH_TOKENSecretCanvas OAuth refresh token (advanced) — bootstrap via canvas-parent-mcp-qr-login
CANVAS_NAMEFriendly name for the Canvas instance (defaults to the host portion of the base URL)
CANVAS_SESSION_CACHESet to false to disable the on-disk session cache and re-authenticate on every process start. Defaults to enabled.
CANVAS_SESSION_FILEAbsolute path for the session cache file. Defaults to $MCP_DATA_DIR/.canvas-parent-mcp/session.json.
CANVAS_OUTPUT_DIRDirectory canvas_download_file may write into (default ~/Downloads). A relative destinationPath is resolved against it.
CANVAS_DISABLE_FETCHPROXYSet to 1 to turn off the browser (fetchproxy) fallback, so missing credentials are a hard error instead.
FETCHPROXY_WS_PORTLocalhost port of the fetchproxy concentrator the ContextMint Bridge extension connects to (default 37149). Every MCP on one machine shares it, so move it for all of them or not at all.
FETCHPROXY_WS_HOSTBind interface for the fetchproxy concentrator, a literal IP only (default 127.0.0.1). Keep on loopback; it exists for hosted deployments that run each MCP in its own network namespace.
FETCHPROXY_IDENTITY_DIRAbsolute path where the fetchproxy long-term identity keypair is stored (default ~/.fetchproxy/identity/).

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npmcanvas-parent-mcp2.1.10

Tools

19

Saved tool list · updated 2w ago

This tool takes no parameters.

Details

From the project README

canvas-parent-mcp

CI npm license

MCP server for Canvas LMS (Instructure), scoped for parent observers and student self-access. Targets https://cms.instructure.com by default but works against any Canvas instance.

Mirrors the read-only parent-portal scope of sibling infinitecampus-mcp. Users interact via the canvas_* tool prefix.

Tools

18 tools across profile, observees, courses, assignments, submissions, grades, calendar, planner, announcements, conversations, discussions, and files.

DomainTools
Profilecanvas_get_profile
Observeescanvas_list_observees
Coursescanvas_list_courses, canvas_get_course
Assignmentscanvas_list_assignments, canvas_list_missing_submissions
Submissionscanvas_get_submission, canvas_list_recent_submissions (default 14d window)
Gradescanvas_list_enrollments
Calendarcanvas_list_calendar_events, canvas_list_upcoming_events
Plannercanvas_list_planner_items
Announcementscanvas_list_announcements
Conversationscanvas_list_conversations, canvas_get_conversation
Discussionscanvas_list_discussion_topics
Filescanvas_list_course_files, canvas_download_file

Tools that the harness will gate as write/IO operations: canvas_download_file.

canvas_download_file only fetches /files/… URLs on your CANVAS_BASE_URL host (https), so your Canvas credential is never sent anywhere else, and it only writes inside a download directory: CANVAS_OUTPUT_DIR if set, otherwise ~/Downloads. A relative destinationPath is resolved against that directory. It never writes through a symlink at the destination, and new files are created owner-only (0600).

Configuration

Set CANVAS_BASE_URL plus one of four auth modes. canvas-parent-mcp tries them in priority order:

  1. CANVAS_TOKEN → personal access token
  2. CANVAS_CLIENT_ID + CANVAS_CLIENT_SECRET + CANVAS_REFRESH_TOKEN → OAuth
  3. CANVAS_USERNAME + CANVAS_PASSWORD → session-scrape (direct Canvas accounts only)
  4. fetchproxy fallback → no env vars needed; reads canvas_session + pseudonym_credentials cookies from your signed-in Canvas tab via the ContextMint Bridge browser extension

If none succeed, you get an error that names every escape hatch.

Mode A — fetchproxy fallback (recommended, zero config)
CANVAS_BASE_URL=https://cms.instructure.com

Install the ContextMint Bridge browser extension from its releases page (Chrome: download the chrome zip, unzip it, and load it unpacked at chrome://extensions with Developer mode on — there is no Chrome Web Store listing yet; Safari: not available yet — it will ship inside the ContextMint app, which has no public download yet, so use Chrome for now), sign into your Canvas instance, and the MCP reads your session cookies from the browser on the first request and again whenever Canvas answers 401 (the session expired). In between, Canvas API calls go directly from Node — the extension is not in the request hot path, but it must stay reachable (browser running, extension installed) for the MCP to renew the session. Works with any auth flow (SSO/SAML/2FA included) because Canvas itself handled the sign-in.

Where the extension comes from. ContextMint Bridge is the fetchproxy browser extension under its new name, from the same maintainer — fetchproxy's own README (Extension) points to it. Its source is public at nullnet-app/contextmint-bridge: build it yourself (npm run build, per its README), or check a release zip against the .sha256 file published beside it:

shasum -a 256 -c contextmint-bridge-chrome-<version>.zip.sha256

Multiple districts? Declared domain instructure.com matches every *.instructure.com host, so you only pair the extension once. The MCP uses whichever district you set in CANVAS_BASE_URL.

Set CANVAS_DISABLE_FETCHPROXY=1 to opt out (missing creds become a hard error — useful in headless CI).

Mode B — username/password (legacy session-scrape)
CANVAS_BASE_URL=https://cms.instructure.com
[email protected]
CANVAS_PASSWORD=your-canvas-password
CANVAS_NAME=cms                # optional, defaults to host portion of base URL

Direct Canvas accounts only — won't work with SAML/Google/Microsoft SSO or 2FA. Brittle (breaks on every Canvas login-page restyling). Prefer fetchproxy if your tab is already signed in. Treat .env like a password file.

Advanced alternatives
Personal access token — simplest if your admin allows it
CANVAS_BASE_URL=https://cms.instructure.com
CANVAS_TOKEN=your-personal-access-token

Generate via Canvas → Account → Settings → "+ New Access Token". Most institutions have disabled this for non-admins.

OAuth via mobile QR code — bootstrapped from the mobile-app login flow
CANVAS_BASE_URL=https://cms.instructure.com
CANVAS_CLIENT_ID=...
CANVAS_CLIENT_SECRET=...
CANVAS_REFRESH_TOKEN=...

If your account uses SSO and you can't use fetchproxy (e.g. headless server), mint OAuth credentials by reusing the Canvas mobile-app QR-login flow — see Bootstrapping OAuth via the mobile QR code below.

Precedence when multiple are set: CANVAS_TOKEN > username/password > OAuth > fetchproxy.

See .env.example.

Session cache

In username/password and OAuth modes the signed-in session is cached between runs, so a restart does not log in (or spend a refresh-token exchange) again. The cache file — $MCP_DATA_DIR/.canvas-parent-mcp/session.json by default, or CANVAS_SESSION_FILE — holds the live canvas_session + pseudonym_credentials cookies or the OAuth access token in plaintext. It is created owner-only (0600, in a 0700 directory), and only the credential binding is stored as a salted digest; your username, password and refresh token are never written to it. Token and fetchproxy modes never write the cache.

Backup and sync tools that run as you can still copy that file. On a shared or backed-up machine, set CANVAS_SESSION_CACHE=false to keep the session in memory only (each start then re-authenticates).

Bootstrapping OAuth via the mobile QR code

If your Canvas admin has disabled personal-access-token creation (some institutions restrict tokens to "the mobile app only") AND your account uses SSO so username/password can't auth, you can mint OAuth credentials by going through the same QR-login flow that the official Canvas mobile apps use:

  1. In Canvas web, open Account → QR for Mobile Login — Canvas shows a QR that's valid for 10 minutes.

  2. Decode the QR with any QR reader. The result is a URL on sso.canvaslms.com like https://sso.canvaslms.com/canvas/login?domain=...&code=....

  3. Run the bundled helper:

    npx canvas-parent-mcp-qr-login "<decoded-qr-url>" >> .env
    

    It hits Canvas's public mobile_verify.json endpoint to fetch the mobile client_id/client_secret, exchanges the QR's one-time code for an access+refresh token pair, and prints CANVAS_BASE_URL / CANVAS_CLIENT_ID / CANVAS_CLIENT_SECRET / CANVAS_REFRESH_TOKEN to stdout. The refresh token is sensitive — treat it like a password.

This reuses the same SSO + OAuth endpoints the official Canvas Student/Parent apps use; from Canvas's perspective the resulting session looks like a mobile-app session. Use it only against accounts you legitimately control.

Status

Unofficial — not affiliated with Instructure. AI-maintained.

Acknowledgement of Terms

By using this MCP server, you acknowledge and agree to the following:

1. This server accesses your own Canvas account via the official Canvas REST API. Auth happens via your own personal access token, issued by your institution. It does not — and cannot — access anyone else's enrollments, grades, or messages.

2. Instructure's Canvas API Policy governs your use of this server, in addition to your institution's own acceptable-use policy. The clauses most relevant here:

You may not use our APIs on behalf of any third-party… You may not use or access our APIs for competitive purposes… You may not interfere with our APIs, our systems, or other users… You may not circumvent any contractual usage limits.

On rate limits: "limits are enforced per user access token… with dynamic throttling." On data: "Any user information retrieved through the API—including course enrollments, grades, and profile information—should be considered and treated as private information."

You are agreeing to those terms — read by the maintainer 2026-05-23 — every time you invoke a tool in this server.

3. Personal, observer/student/parent use only. This project is not affiliated with, endorsed by, sponsored by, or in partnership with Instructure, Inc. or any school district. It is a personal automation tool for an authenticated Canvas user (typically a parent observer) to read their own (or their student's) enrollments, assignments, grades, and announcements. Do not use it to bulk-extract a district's course content, redistribute student data, or train AI models on student records.

4. FERPA + your institution's AUP apply. Student educational records are protected under the federal Family Educational Rights and Privacy Act (FERPA). Even though your token grants you lawful access, how you store, redistribute, or feed that data into LLMs is regulated. Treat any output (grades, assignments, comments, conversations) as confidential student data. Your institution's acceptable-use policy may add further restrictions on automated access — check before automating.

5. Your token is yours alone. Do not commit CANVAS_API_TOKEN to git, do not paste it in shared chats, and rotate it if it's ever exposed. A leaked token grants full Canvas access scoped to your user.

6. You accept full responsibility for any consequences of using this server in connection with your Canvas account — rate limiting (dynamic throttling kicks in well below documented limits when Canvas is under load), token revocation, account warnings, institution-admin investigations, or any enforcement action. If Instructure or your institution objects to your use, stop using this server.

This section is the maintainer's good-faith summary of the terms — it is not legal advice and does not modify or supersede Instructure's actual Canvas API Policy or your institution's policies.

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.