canvas-api-mcp
An MCP server for Canvas LMS. 15 curated tools for everyday student work, plus a gateway that reaches every endpoint your Canvas instance exposes.
📖 Documentation: mcp.johannsenlum.com/canvas-lms — install guide · tool reference · skills · compliance
Personal-use software. Canvas's API Policy requires OAuth for applications used by multiple people, and Canvas OAuth cannot be implemented safely by locally installed software (no PKCE, and
client_secretcannot be shipped in a package). Use this with your own token on your own account. See Compliance.
What you can ask it
Real prompts, and which tool answers them.
You: What's due this week? Claude: (calls
whats_due) — You have 3 things due: Problem Set 4 (Thu, CS3230), a discussion reply (Fri, IS4302), and the Milestone 2 report (Sun, EE2211).
You: How am I doing in my databases course, and what's on the syllabus for week 6? Claude: (calls
my_grades, thenget_pagefor the syllabus, thencourse_contentfor the week 6 module) — You're at 87% overall. Week 6 covers normalization and has a reading plus a lab file due Friday.
You: Summarize the PDF lecture notes for lecture 8 and pull up my submission for the essay so I can see the feedback. Claude: (calls
list_files+read_filefor the PDF, thenmy_submissionfor the essay) — ...
You: Reply to the "Project teams" discussion and say I'm free after 3pm for the group meeting. Claude: (calls
post_discussion_reply✏️) — Posted to the thread.
You: Has Canvas ever given me quiz statistics broken down by question, across the whole semester? Claude: (calls
search_canvas_apito find the right endpoint, thencanvas_requestto call it) — ...
The last example is the point of the gateway tools: if an endpoint exists on your
Canvas instance, search_canvas_api can find it and canvas_request can call it,
even though only 15 tools are hand-curated.
Install
Prerequisites
- Python 3.11+
- A Canvas personal access token. Your institution must allow students to create them: check Canvas → Account → Settings → Approved Integrations for a "+ New access token" button. Full walkthrough with screenshots: mcp.johannsenlum.com/canvas-lms/install.
Running the server
The PyPI package name canvas-api-mcp is reserved but not yet published.
Until it is, install straight from GitHub:
uvx --from git+https://github.com/JohannsenLum/canvas-api-mcp canvas-api-mcp
Once published, this shortens to:
uvx canvas-api-mcp
(uvx canvas-api-mcp on its own does not work yet — it will 404 against PyPI
until the package ships. Use the git+ form above until then.)
Or run from a local clone:
git clone https://github.com/JohannsenLum/canvas-api-mcp
cd canvas-api-mcp
uv sync
Quick install (one-click)
One-click deeplinks exist for Cursor, VS Code, and LM Studio only — no other
client has a documented install-link format. These prefill the config below but
still need CANVAS_BASE_URL and CANVAS_TOKEN filled in afterward.
All clients (manual config)
Your token stays on your machine, in your own config file. It is never transmitted anywhere except directly to your Canvas instance.
| Client | Deeplink? |
|---|---|
| Claude Code | no |
| Claude Desktop | no |
| Cursor | yes, above |
| VS Code | yes, above |
| LM Studio | yes, above |
| Zed | no |
| Windsurf | no (Windsurf only resolves servers in its own registry) |
Claude Code — ~/.claude.json
{
"mcpServers": {
"canvas": {
"command": "uvx",
"args": [
"--from", "git+https://github.com/JohannsenLum/canvas-api-mcp",
"canvas-api-mcp"
],
"env": {
"CANVAS_BASE_URL": "https://canvas.yourschool.edu",
"CANVAS_TOKEN": "your-token-here"
}
}
}
}
Once published to PyPI, args simplifies to ["canvas-api-mcp"].
Claude Desktop — claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
No one-click install exists for Claude Desktop (it installs .mcpb bundles, not
deeplinks) — copy this JSON in via Settings → Developer → Edit Config:
{
"mcpServers": {
"canvas": {
"command": "uvx",
"args": [
"--from", "git+https://github.com/JohannsenLum/canvas-api-mcp",
"canvas-api-mcp"
],
"env": {
"CANVAS_BASE_URL": "https://canvas.yourschool.edu",
"CANVAS_TOKEN": "your-token-here"
}
}
}
}
Cursor — ~/.cursor/mcp.json
Fallback for the button above, or if you'd rather paste it directly:
{
"mcpServers": {
"canvas": {
"command": "uvx",
"args": [
"--from", "git+https://github.com/JohannsenLum/canvas-api-mcp",
"canvas-api-mcp"
],
"env": {
"CANVAS_BASE_URL": "https://canvas.yourschool.edu",
"CANVAS_TOKEN": "your-token-here"
}
}
}
}
VS Code — .vscode/mcp.json
Fallback for the button above, or if you'd rather paste it directly. Note VS
Code uses a servers key, not mcpServers:
{
"servers": {
"canvas": {
"type": "stdio",
"command": "uvx",
"args": [
"--from", "git+https://github.com/JohannsenLum/canvas-api-mcp",
"canvas-api-mcp"
],
"env": {
"CANVAS_BASE_URL": "https://canvas.yourschool.edu",
"CANVAS_TOKEN": "your-token-here"
}
}
}
}
LM Studio — mcp.json (Program → Install → Edit mcp.json)
Fallback for the button above, or if you'd rather paste it directly:
{
"mcpServers": {
"canvas": {
"command": "uvx",
"args": [
"--from", "git+https://github.com/JohannsenLum/canvas-api-mcp",
"canvas-api-mcp"
],
"env": {
"CANVAS_BASE_URL": "https://canvas.yourschool.edu",
"CANVAS_TOKEN": "your-token-here"
}
}
}
}
Zed — settings.json
No deeplink exists for Zed — add this under context_servers in your Zed
settings:
{
"context_servers": {
"canvas": {
"source": "custom",
"command": "uvx",
"args": [
"--from", "git+https://github.com/JohannsenLum/canvas-api-mcp",
"canvas-api-mcp"
],
"env": {
"CANVAS_BASE_URL": "https://canvas.yourschool.edu",
"CANVAS_TOKEN": "your-token-here"
}
}
}
}
Windsurf — ~/.codeium/windsurf/mcp_config.json
No deeplink exists for Windsurf — it only resolves servers from its own registry, so this has to be pasted in manually via Windsurf Settings → MCP Servers → Edit raw config:
{
"mcpServers": {
"canvas": {
"command": "uvx",
"args": [
"--from", "git+https://github.com/JohannsenLum/canvas-api-mcp",
"canvas-api-mcp"
],
"env": {
"CANVAS_BASE_URL": "https://canvas.yourschool.edu",
"CANVAS_TOKEN": "your-token-here"
}
}
}
}
Tools
| Tool | What it does |
|---|---|
whoami |
Identity and your role in each course |
my_courses |
Active courses with code, term, role |
whats_due |
Everything due, soonest first |
my_grades |
Current score per course |
list_assignments |
A course's assignments and submission state |
get_assignment |
One assignment in full, with rubric |
my_submission |
Your submission, score, and feedback |
submit_assignment ✏️ |
Submit work |
course_announcements |
Recent announcements |
course_content |
Modules and their contents |
list_files |
Files in a course |
read_file |
Extract text from PDF/DOCX/PPTX/text |
get_page |
A Canvas page, e.g. the syllabus |
read_discussion |
Topics, or one topic's replies |
post_discussion_reply ✏️ |
Post to a discussion |
search_canvas_api |
Find any endpoint by keyword (gateway) |
canvas_request ✏️ |
Execute any endpoint (gateway) |
✏️ writes to Canvas. That's 3 write tools total: submit_assignment,
post_discussion_reply, and canvas_request when called with a non-GET method
(GET calls through canvas_request are read-only).
search_canvas_api + canvas_request reach all ~1,116 endpoints your instance
exposes. What they may do is decided by Canvas from your token's permissions — a
teacher token unlocks educator endpoints with no change to this server.
Prompts
week_ahead, study_pack, grade_check.
Resources
canvas://me, canvas://courses, canvas://api/catalog.
Skills
If your client supports the skills convention:
npx skills add JohannsenLum/canvas-api-mcp
Other institutions
Works with any Canvas instance — set CANVAS_BASE_URL. The catalog of ~1,116
endpoints ships inside the package at
canvas_api_mcp/data/catalog.json. To match your deployment's exact feature
set, regenerate it:
python scripts/build_catalog.py https://canvas.yourschool.edu -o data/catalog.json
Compliance
- Academic integrity.
submit_assignmentcan submit anything, including AI-generated work. Submitting work that is not your own breaches the academic integrity rules of essentially every institution, and Canvas's API Policy explicitly prohibits use that violates them. That is on you. - Rate limiting. The client throttles against Canvas's published quota. Do not remove it — overloading the API is prohibited.
- Course material.
read_filefetches materials for your own study. Do not redistribute them. - Your token is password-equivalent. It can read your grades and submit work as you. Set an expiry. Never commit it.
- Personal-use scope. Phase 1 targets a single student using their own token. There are no curated educator tools; Canvas's OAuth flow has no PKCE, so this locally-installed server cannot implement the multi-user OAuth that Canvas's API Policy requires for anything broader. Do not repackage this as a multi-tenant service.
Development
uv sync
uv run pytest -v
# Live tests against your real account (read-only)
CANVAS_LIVE_TESTS=1 uv run pytest tests/test_live.py -v
Environment variables: CANVAS_BASE_URL, CANVAS_TOKEN, optional
CANVAS_MAX_PAGES (default 10). See env.template.
Contributing
Issues and pull requests are welcome — see CONTRIBUTING.md for setup, the architectural rules worth knowing before you change anything, and the bar for adding a new curated tool.
Found a security problem? Do not open a public issue. See SECURITY.md for private reporting — particularly important here, since this project handles password-equivalent Canvas tokens.
Changes are recorded in CHANGELOG.md.
Licence
MIT © 2026 Johannsen Lum.
Use it, change it, redistribute it, build something commercial on it — the only condition is that you keep the copyright notice and licence text. It comes with no warranty of any kind.
Contributions are accepted under the same licence.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file canvas_api_mcp-0.0.1.tar.gz.
File metadata
- Download URL: canvas_api_mcp-0.0.1.tar.gz
- Upload date:
- Size: 188.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f7e686a950a24ef3be39d91b9538f8a0d86fee1f14716ef0f7ac2becb6d0c883
|
|
| MD5 |
46305c42fbfe2ba83f275ac74de7e7a4
|
|
| BLAKE2b-256 |
cc38d78dbbe3ba125c6f834619d841415a1cf16f1ea429b54787e53661dbf959
|
Provenance
The following attestation bundles were made for canvas_api_mcp-0.0.1.tar.gz:
Publisher:
publish.yml on JohannsenLum/canvas-api-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
canvas_api_mcp-0.0.1.tar.gz -
Subject digest:
f7e686a950a24ef3be39d91b9538f8a0d86fee1f14716ef0f7ac2becb6d0c883 - Sigstore transparency entry: 2368501079
- Sigstore integration time:
-
Permalink:
JohannsenLum/canvas-api-mcp@c113b86dd551e1e4381842a2c5fe785ee703a97c -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/JohannsenLum
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c113b86dd551e1e4381842a2c5fe785ee703a97c -
Trigger Event:
release
-
Statement type:
File details
Details for the file canvas_api_mcp-0.0.1-py3-none-any.whl.
File metadata
- Download URL: canvas_api_mcp-0.0.1-py3-none-any.whl
- Upload date:
- Size: 65.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
deb909d8bbf90e9beed0af43525543272e2d7ada218f4d246ec1f7e6e0288e7c
|
|
| MD5 |
0531225717dd1c3ab3d35d39299da873
|
|
| BLAKE2b-256 |
a87aebad0c4b5178626a574a01bc931d731a4fe622d367551cb0190287a054b7
|
Provenance
The following attestation bundles were made for canvas_api_mcp-0.0.1-py3-none-any.whl:
Publisher:
publish.yml on JohannsenLum/canvas-api-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
canvas_api_mcp-0.0.1-py3-none-any.whl -
Subject digest:
deb909d8bbf90e9beed0af43525543272e2d7ada218f4d246ec1f7e6e0288e7c - Sigstore transparency entry: 2368501112
- Sigstore integration time:
-
Permalink:
JohannsenLum/canvas-api-mcp@c113b86dd551e1e4381842a2c5fe785ee703a97c -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/JohannsenLum
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c113b86dd551e1e4381842a2c5fe785ee703a97c -
Trigger Event:
release
-
Statement type: