boyuchengz/canvas-mcp

选用指南

AI 根据 README 整理 · 2026/10/26 11:26:25

适用场景

适用于学生通过AI助手查询课程截止日期、作业缺失情况、成绩构成和教师反馈等场景。

查看 README 依据

Deploy it once, add it as a custom connector in Claude or ChatGPT, and ask questions about your courses in plain language: > *What's due this week, and which of it have I already submitted?* > *What do I need on the final to keep an A in CS 225?* > *Summarize the announcements from the last two weeks.* > *Did the TA leave any comments on my last lab?* Every one of the 26 tools issues `GET` requests only. The server cannot submit, post, delete or mark anything as read, so even a leaked connector URL only exposes what you could already see. ## Contents - [Features](#features)

使用方式

部署后作为自定义连接器添加到Claude或ChatGPT，通过自然语言提问使用。

查看 README 依据

Deploy it once, add it as a custom connector in Claude or ChatGPT, and ask questions about your courses in plain language: > *What's due this week, and which of it have I already submitted?* > *What do I need on the final to keep an A in CS 225?* > *Summarize the announcements from the last two weeks.* > *Did the TA leave any comments on my last lab?* Every one of the 26 tools issues `GET` requests only. The server cannot submit, post, delete or mark anything as read, so even a leaked connector URL only exposes what you could already see. ## Contents - [Features](#features)

2. **Settings → Networking**: click **Generate Domain**. Your connector URL is: ``` https://<your-domain>/<MCP_SECRET>/mcp ``` Render, Fly.io, a VPS and local setups are covered in [docs/deployment.md](docs/deployment.md). ## Connecting a client **Claude** (claude.ai, desktop and mobile): open **Settings → Connectors**, choose **Add custom connector**, and paste the connector URL. Leave the OAuth fields empty. **ChatGPT**: enable developer mode for connectors, create a new connector, paste the connector URL and choose **No authentication**. **Claude Code**: ```bash

部署要求

需要Node.js 20+环境，并配置CANVAS_BASE_URL、CANVAS_API_TOKEN和MCP_SECRET三个环境变量。

查看 README 依据

> Some institutions restrict personal access tokens. Check your school's acceptable-use policy before deploying. ### 2. Generate a connector secret ```bash node -e "console.log(require('crypto').randomBytes(24).toString('hex'))" ``` ### 3. Deploy The server runs anywhere Node.js 20+ can accept HTTPS traffic. [Railway](https://railway.com) is the quickest option: ```bash npm i -g @railway/cli railway login railway init railway up ``` Then, in the Railway dashboard: 1. **Variables**: add `CANVAS_BASE_URL`, `CANVAS_API_TOKEN` and `MCP_SECRET`.

claude mcp add --transport http canvas https://<your-domain>/<MCP_SECRET>/mcp ``` **Any other MCP client** that supports the Streamable HTTP transport can use the same URL. Start a conversation with something like *"List my Canvas courses"* to confirm it works. ## Configuration | Variable | Required | Description | | --- | --- | --- | | `CANVAS_BASE_URL` | yes | Your Canvas instance, e.g. `https://canvas.instructure.com` or `https://canvas.<school>.edu` | | `CANVAS_API_TOKEN` | yes | Personal access token from Canvas |

已知限制

每个部署只能服务一个用户；不解析PDF、幻灯片和Office文件；列表每次调用最多500项，长文本限制为20000字符。

查看 README 依据

- Each deployment serves one user, since the server acts as whoever owns the token. Run a separate instance for each person. - PDFs, slides and Office files aren't parsed. `get_file` returns a temporary download link for them instead. - New Quizzes appear in `list_assignments`, not `list_quizzes`, and the Canvas API never exposes quiz questions to students. - Lists are capped at 500 items (5 pages of 100) per call, and long text at 20,000 characters. - `get_calendar_events` without a `course_id` covers at most 10 courses, which is a Canvas API limit. ## Development ```bash