MCP Canvas Lms

🚀 Canvas MCP 服務器

Canvas MCP 服務器是一個用於與 Canvas API 交互的模型上下文協議 (MCP) 服務器。藉助該服務器，您能夠輕鬆管理課程、作業、選課和成績等操作。

🚀 快速開始

先決條件

• Node.js：版本 18 或更高
• Canvas API 令牌：需從您的 Canvas 賬戶獲取
• Canvas 域名：通常為 canvas.instructure.com

設置

1. 克隆倉庫

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

2. 安裝依賴項

npm install

3. 配置環境變量 複製示例環境文件：

cp .env.example .env

編輯 .env 文件，並用您的實際 Canvas API 令牌和域名替換佔位符。 構建項目：

npm run build

4. 運行服務器

npm start

服務器將啟動並通過標準輸入輸出監聽 MCP 請求。

連接到 Claude Desktop

1. 更新 Claude 配置 在您的 claude_desktop_config.json 中添加 MCP 服務器配置：

  "canvas-mcp-server": {
      "command": "npx",
      "args": ["-y", "canvas-mcp-server"]
    },

2. 重啟 Claude Desktop
   • 完全退出 Claude Desktop。
   • 再次啟動 Claude Desktop。
   • 在 🔌 菜單中找到並連接您的 Canvas MCP 服務器。

✨ 主要特性

可用工具（更多針對學生的功能即將推出）

• canvas_create_course：創建 Canvas 中的新課程。
• canvas_update_course：更新現有課程。
• canvas_create_assignment：在 Canvas 課程中創建新作業。
• canvas_update_assignment：更新現有作業。
• canvas_submit_grade：提交學生作業的成績。
• canvas_enroll_user：將用戶加入課程。

錯誤處理

工具通過返回包含 isError: true 的錯誤消息來指示問題。請確保所有必需的環境變量都已設置，以避免運行時錯誤。

故障排除

• 構建錯誤：
  • 檢查 TypeScript 版本：npx tsc --version
  • 清理並重新構建：rm -rf build/ && npm run build
• 運行時錯誤：
  • 檢查日誌以獲取詳細錯誤消息。
  • 確保環境變量正確設置。
• 類型錯誤：
  • 使用 TypeScript 的類型檢查驗證類型：npx tsc --noEmit

🔧 技術細節

• 類型安全：types.ts 文件確保 Canvas API 的所有交互都是類型安全的，從而減少運行時錯誤並提高代碼維護性。
• 錯誤處理：服務器通過返回有意義的消息並設置 isError 標誌來優雅地處理錯誤，允許客戶端（例如 Claude Desktop）理解和響應。
• 環境變量：使用環境變量管理敏感信息（如 API 令牌），以增強安全性和不同環境之間的靈活性。
• 模塊化：將關注點分開到不同的文件（如 types.ts、client.ts、index.ts）使代碼庫更易於導航和維護。

🤝 貢獻

歡迎貢獻！請打開問題或提交拉取請求以報告任何改進或錯誤修復。

📄 許可證

本項目根據 MIT 許可證發佈。

額外說明

根據項目的具體需求，您可以隨意調整文件路徑和配置。如果您有任何其他問題，請隨時告知！