Canvas Learning Management System

🚀 Canvas MCP 服务器

Canvas MCP 服务器实现了与 Canvas 学习管理系统 (LMS) API 对接的消息控制协议 (MCP)，可与 Claude Desktop 及其他潜在 MCP 客户端配合使用，为用户提供便捷的 Canvas LMS API 访问途径。

🚀 快速开始

Canvas MCP 服务器提供了一个本地接口来访问 Canvas LMS API，借助该服务器，您可以轻松地列出和管理课程、访问作业和提交、查看公告、获取课程大纲和模块、管理用户和注册信息以及生成课程摘要。

✨ 主要特性

• 课程管理：能够列出和管理课程，方便用户对课程进行统筹安排。
• 作业与提交访问：可直接访问作业和提交情况，便于跟踪学习进度。
• 公告查看：及时查看课程公告，不错过重要信息。
• 大纲与模块获取：获取课程大纲和模块，清晰了解课程结构。
• 用户与注册管理：管理用户和注册信息，保障系统使用的有序性。
• 课程摘要生成：自动生成课程摘要，帮助用户快速掌握课程要点。

📦 安装指南

先决条件

• Python 3.x
• 虚拟环境 (venv)
• Canvas API 令牌
• Canvas API URL（例如 https://canvas.illinois.edu/api/v1）

安装步骤

1. 克隆此仓库：

git clone https://github.com/vishalsachdev/canvas-mcp.git
cd canvas-mcp

2. 创建并激活虚拟环境：

python -m venv canvas-mcp
source canvas-mcp/bin/activate  # 在 Unix/macOS 上

3. 安装依赖项：

pip install -r requirements.txt

4. 安装 MCP 服务器：

pip install .

🔧 配置说明

1. 创建环境文件

在根目录中创建一个 .env 文件，包含以下变量：

CANVAS_API_TOKEN=your_canvas_api_token_here
CANVAS_API_URL=https://canvas.youruniversity.edu/api/v1

用您实际的值替换：

• 您的 Canvas API 令牌（如何获取您的 Canvas API 令牌）
• 您所在机构的 Canvas API URL

2. 配置启动脚本

start_canvas_server.sh 脚本已经配置为：

• 从 .env 文件加载环境变量
• 启动虚拟环境
• 运行缓存服务器实现

将启动脚本标记为可执行：

chmod +x start_canvas_server.sh

3. 配置 Claude Desktop

1. 如果尚未安装，请下载并安装 Claude Desktop。
2. 打开 Claude 应用，导航到 Settings（设置）。
3. 在左侧菜单中选择 Environment Variables（环境变量）。
4. 添加以下变量：
   • 名称：CANVAS_API_TOKEN 值：您的 Canvas API 令牌
   • 名称：CANVAS_API_URL 值：您机构的 Canvas API URL

💻 使用示例

基础用法

启动 MCP 服务器：

python -m canvas_mcp.server

⚠️ 安全考虑

⚠️ 重要提示

• 您的 Canvas API 令牌授予访问您的 Canvas 帐户的权限，务必妥善保管。
• 切勿将 .env 文件提交到版本控制系统中，防止信息泄露。
• 考虑使用权限受限的令牌（如果可能），降低安全风险。
• 该服务器在您本地计算机上运行，不会对外暴露您的凭证，但仍需注意本地安全。

🤝 贡献说明

欢迎贡献！请随意：

• 提交问题报告错误或功能请求
• 创建拉取请求以改进项目
• 分享您的用例和反馈

📄 许可证

该项目使用 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。

由 Vishal Sachdev 创建