Canvas MCP 服务器

此仓库包含一个消息控制协议 (MCP) 服务器实现，用于与 Canvas 学习管理系统 API 交互。该服务器设计用于与 Claude Desktop 以及潜在的其他 MCP 客户端一起使用。

概述

Canvas MCP 服务器提供了一个 Canvas LMS API 的本地接口，允许您：

• 列出和管理课程
• 访问作业和提交
• 查看公告
• 检索课程大纲和模块
• 管理用户和注册
• 生成课程摘要

前提条件

• Python 3.x
• 虚拟环境 (venv)
• Canvas API Token
• 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

配置

1. 创建环境变量文件

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

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

将这些值替换为：

• 您的 Canvas API Token (如何获取您的 Canvas API token)
• 您大学的 Canvas API URL

2. 配置启动脚本

start_canvas_server.sh 脚本已经配置为：

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

使启动脚本可执行：

chmod +x start_canvas_server.sh

3. Claude Desktop 配置

1. 如果您还没有安装 Claude Desktop，请安装。

2. 创建或编辑 Claude Desktop 配置文件：

vim ~/Library/Application\ Support/Claude/claude_desktop_config.json

3. 添加 Canvas MCP 服务器配置：

{
  "mcpServers": [
    {
      "name": "canvas-api",
      "command": "/Users/YOUR_USERNAME/path/to/canvas-mcp/start_canvas_server.sh"
    }
  ]
}

将 /Users/YOUR_USERNAME/path/to/canvas-mcp 替换为您克隆此仓库的绝对路径。

4. 重新启动 Claude Desktop 以加载新配置。

可用工具

该服务器为 Canvas LMS 交互提供以下工具：

课程管理

• list_courses: 列出已验证用户的所有课程
• get_course_details: 获取有关特定课程的详细信息
• summarize_course: 生成课程的综合摘要

作业

• list_assignments: 列出课程的所有作业
• get_assignment_details: 获取有关特定作业的详细信息
• get_assignment_description: 获取作业的完整描述

提交

• list_submissions: 列出特定作业的所有提交

用户

• list_users: 列出注册课程的所有用户

资源

• list_announcements: 列出课程的所有公告
• get_course_syllabus: 获取课程的大纲
• get_course_modules: 获取课程的所有模块

与 Claude Desktop 一起使用

此 MCP 服务器设计为与 Claude Desktop 无缝协作：

1. Claude Desktop 将在需要时自动启动服务器
2. 您将在 Claude Desktop 界面中看到 Canvas API 工具（锤子图标 🔨）
3. 您可以要求 Claude 执行 Canvas 操作，例如“显示我的课程”或“获取我的生物课程的大纲”

对于手动测试，您可以直接启动服务器：

./start_canvas_server.sh

技术细节

服务器实现

该服务器使用：

• fastmcp: 一个用于构建 MCP 服务器的 Python 库
• httpx: 用于对 Canvas API 进行异步 HTTP 请求
• 缓存机制，以提高课程查找的性能

主要实现文件是 canvas_server_cached.py，它提供：

• 课程信息的有效缓存
• Canvas API 请求的分页处理
• 错误处理和报告
• 支持课程 ID 和课程代码

依赖项

该服务器需要以下 Python 包：

• httpx: 用于 HTTP 请求
• fastmcp: 用于 MCP 服务器实现
• requests: 用于某些 HTTP 操作
• 其他用于编码和联网的标准库

故障排除

如果您遇到问题：

1. 服务器无法启动

   • 检查您的 .env 文件是否存在并包含有效的凭据
   • 验证 start_canvas_server.sh 中的虚拟环境路径
   • 确保已安装所有依赖项

2. 身份验证错误

   • 验证您的 Canvas API token 是否有效且未过期
   • 检查您是否在 Canvas 中具有必要的权限

3. 连接问题

   • 确保您的 Canvas API URL 正确
   • 检查您的互联网连接
   • 验证您的机构是否限制了 API 访问

4. 调试

   • 检查 Claude Desktop 控制台中的服务器日志
   • 尝试手动运行服务器以查看错误输出

安全注意事项

• 您的 Canvas API token 授予对您的 Canvas 帐户的访问权限
• 永远不要将您的 .env 文件提交到版本控制
• 如果可能，请考虑使用具有有限权限的 token
• 该服务器在您的本地计算机上运行，不会在外部暴露您的凭据

贡献

欢迎贡献！ 随意：

• 提交错误或功能请求的问题
• 创建包含改进的 pull 请求
• 分享您的用例和反馈

许可证

该项目已获得 MIT 许可证的许可 - 有关详细信息，请参见 LICENSE 文件。

---

由 Vishal Sachdev 创建