Skip to main content

Manage courses, submissions, grades, and student data in Canvas LMS

Project description

Canvas MCP Server

Base URL: https:///api/v1

Category Developer Tools
Tools 673
Auth Bearer Token, OAuth2

Install

Quick Start (recommended)

OAUTH2_CLIENT_ID=YOUR_OAUTH2_CLIENT_ID \
OAUTH2_CLIENT_SECRET=YOUR_OAUTH2_CLIENT_SECRET \
BEARER_TOKEN=YOUR_BEARER_TOKEN \
SERVER_CANVAS_DOMAIN=YOUR_SERVER_CANVAS_DOMAIN \
uvx mcparmory-canvas

With pip

pip install mcparmory-canvas
OAUTH2_CLIENT_ID=YOUR_OAUTH2_CLIENT_ID \
OAUTH2_CLIENT_SECRET=YOUR_OAUTH2_CLIENT_SECRET \
BEARER_TOKEN=YOUR_BEARER_TOKEN \
SERVER_CANVAS_DOMAIN=YOUR_SERVER_CANVAS_DOMAIN \
mcparmory-canvas

MCP Client Configuration

Add to your MCP client config (e.g. Claude Desktop, Cursor, Codex):

{
  "mcpServers": {
    "canvas": {
      "command": "uvx",
      "args": ["mcparmory-canvas"],
      "env": {
        "OAUTH2_CLIENT_ID": "YOUR_OAUTH2_CLIENT_ID",
        "OAUTH2_CLIENT_SECRET": "YOUR_OAUTH2_CLIENT_SECRET",
        "BEARER_TOKEN": "YOUR_BEARER_TOKEN",
        "SERVER_CANVAS_DOMAIN": "YOUR_SERVER_CANVAS_DOMAIN"
      }
    }
  }
}

Set OAUTH2_SCOPES to a comma-separated list of scopes your app requires (e.g. OAUTH2_SCOPES=scope_a,scope_b). Some OAuth2 providers may also use additional scope env vars such as OAUTH2_USER_SCOPES; open .env to see all generated scope buckets and descriptions.


Credentials

Set the following environment variables (via MCP client env config, shell export, or .env file):

  • OAUTH2_CLIENT_ID — OAuth2 client ID
  • OAUTH2_CLIENT_SECRET — OAuth2 client secret
  • BEARER_TOKEN — Bearer token
  • SERVER_CANVAS_DOMAIN — Your Canvas instance hostname from the URL bar when logged in.

Do not commit credentials to version control.

OAuth2

Add this redirect URI to your OAuth provider's allowed redirect URIs:

http://localhost:9400/callback

If you change OAUTH2_CALLBACK_PORT in .env, update the redirect URI to match.

On first use, a browser window opens automatically for OAuth authorization. Grant access when prompted — tokens are saved to tokens/oauth2_tokens.json and refreshed automatically.

Re-authorization: Delete tokens/oauth2_tokens.json and restart the server.


Run Locally

First, configure your credentials in .env (see Credentials above).

pip install -r requirements.txt
python server.py

Connect MCP Client

Edit .mcp.json and replace <SERVER_DIR> with the absolute path to this directory, then add to your MCP client configuration.

Example (if server is at /home/user/mcp-servers/canvas):

{
  "mcpServers": {
    "canvas": {
      "command": "python",
      "args": ["/home/user/mcp-servers/canvas/server.py"]
    }
  }
}

Docker

Pre-built image (recommended)

docker run -p 8000:8000 -p 9400:9400 -v ./tokens:/app/tokens \
  -e OAUTH2_CLIENT_ID=YOUR_OAUTH2_CLIENT_ID \
  -e OAUTH2_CLIENT_SECRET=YOUR_OAUTH2_CLIENT_SECRET \
  -e BEARER_TOKEN=YOUR_BEARER_TOKEN \
  -e SERVER_CANVAS_DOMAIN=YOUR_SERVER_CANVAS_DOMAIN \
  ghcr.io/mcparmory/canvas:latest

Build from source

First, configure your credentials in .env (see Credentials above).

docker build -t canvas .
mkdir -p tokens
docker run -p 8000:8000 -p 9400:9400 -v ./tokens:/app/tokens --env-file .env canvas

Before running, make sure ports 8000, 9400 are free. If you changed the callback port in .env, update the -p port mapping and your OAuth provider's redirect URI to match.

On first run, the server prints an authorization URL — check docker logs for the URL. Open it in your browser to complete OAuth consent. Tokens are persisted to ./tokens/ via the volume mount so re-authorization is not needed on subsequent runs.

MCP client config (Docker)

For Docker, use SSE transport in your MCP client config:

{
  "mcpServers": {
    "canvas": {
      "type": "sse",
      "url": "http://localhost:8000/sse"
    }
  }
}

Files

  • .env - Credentials and server configuration
  • .mcp.json - MCP client config template
  • Dockerfile - Container build
  • LICENSE - MIT license for this generated code
  • requirements.txt - Python dependencies
  • README.md - This file
  • server.py - MCP server entry point
  • _auth.py - Authentication handlers
  • _models.py - Request/response models
  • _validators.py - Input validation

Note: Files starting with . are hidden by default on macOS/Linux. Use ls -a in terminal or enable "Show hidden files" in your file manager to see .env and .mcp.json.


MCP Blacksmith
Generated by MCP Blacksmith · Quickstart docs · Report a bug

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcparmory_canvas-1.0.3-py3-none-any.whl (374.2 kB view details)

Uploaded Python 3

File details

Details for the file mcparmory_canvas-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mcparmory_canvas-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f12949deb6acf3cbc87420bc68f286c7e3d43426d2f705676243d62772976caf
MD5 b59f40be53da12cdb9e4d7a8c0c88c05
BLAKE2b-256 67a897365f82819c76ce997628c97fdf5e2f4c46183c193f179d3678260f9d07

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page