Canvas MCP

🚀 Canvas 画布 MCP 服务器助手

此项目提供的模型上下文协议（MCP）服务器，能让你在不离开 LLM（如 Claude Desktop）的情况下，与 Canvas/Instructure 课程和作业进行交互。你可以通过编程方式检索、搜索和总结课程与作业信息，例如查看即将到期作业的截止日期。

🚀 快速开始

此 MCP 服务器可让你在不离开 LLM（如 Claude Desktop）的环境下，直接与 Canvas/Instructure 课程和作业交互，实现课程和作业信息的便捷管理。

✨ 主要特性

工具

1. 列出课程
   • 可检索课程列表。
   • 支持根据课程状态（活动、已完成或所有）进行筛选。
2. 搜索作业
   • 能在所有课程中搜索作业。
   • 支持多种过滤条件：
     • 搜索查询。
     • 截止日期范围。
     • 特定课程。
     • 包括/排除已完成的课程。
3. 获取作业详细信息
   • 可获取特定作业的详细信息。
   • 支持多种输出格式（完整的 HTML、纯文本、Markdown）。

资源

• 作业内容：可使用统一资源标识符格式检索完整的作业详细信息。

📦 安装指南

先决条件

• Node.js
• Canvas LMS 帐户
• Canvas API 令牌
• Canvas 基准

环境设置

需设置以下环境变量：

• CANVAS_API_TOKEN：你的 Canvas API 访问令牌（获取说明见下方）。
• CANVAS_DOMAIN：你的 Canvas 机构的域名（例如，canvas.youruniversity.edu）。

如何获取你的 Canvas API 令牌

1. 登录到 Canvas。
2. 转到帐户 > 设置。
3. 滚动到“批准的集成”部分。
4. 点击“新建访问令牌”。
5. 复制生成的令牌。

有关更多详细信息，请参阅 Canvas 的这些说明。

安全注意事项

请保持你的 CANVAS_API_TOKEN 机密，切勿将其提交到版本控制。

安装步骤

1. 克隆仓库并安装依赖项 克隆仓库：

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

   安装依赖项。若出现错误，请确保你已安装 node。

   npm install
   

2. 连接到 MCP 服务器 复制以下 JSON 并用适当的 {{PATH}} 值替换：

   {
       "mcpServers": {
           "canvas": {
               "command": "node", 
               "args": ["/absolute/path/to/canvas-mcp/src/index.ts"], // 进入 src 仓库，运行 `pwd` 并在此处输入输出内容
               "env": {
                   "CANVAS_API_TOKEN": "your_api_token_here",
                   "CANVAS_DOMAIN": "myschool.instructure.com"
               }
           }
       }
   }
   

   对于 Claude，将此文件保存为 claude_desktop_config.json 在你的 Claude Desktop 配置目录中：

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

   对于 Cursor，将此文件保存为 mcp.json 在你的 Cursor 配置目录中：

   ~/.cursor/mcp.json
   

3. 重新启动 Claude Desktop / Cursor 打开 Claude Desktop，此时你应能看到 Canvas 作为可用集成。

📚 详细文档

MCP 工具

• canvas：用于连接到 Canvas 平台并执行各种操作，例如检索课程和作业信息、提交作业等。

故障排除

若遇到问题，请检查以下内容：

• 确保 Node.js 和依赖项已正确安装。
• 确保 API 令牌和域名设置正确。
• 查看控制台输出以获取更多错误详细信息。

免责声明

本项目旨在提供一个与 Canvas 平台交互的基础工具。使用前请仔细阅读相关文档并确保遵守 Canvas 的服务条款和隐私政策。