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 的服務條款和隱私政策。