Canvas Lms MCP

🚀 Canvas LMS MCP 服務器

Canvas LMS MCP 服務器是一個用於與 Canvas LMS 系統交互的工具，它可以幫助用戶方便地獲取課程信息、作業信息等。通過簡單的配置和操作，就能快速集成到開發環境中。

🚀 快速開始

環境要求

• 操作系統：支持 Unix-like 系統（如 Linux 或 macOS）
• Python 版本：Python 3.8 或更高版本
• 依賴項：必須安裝 requests 和 canvasapi 庫

安裝步驟

1. 克隆此倉庫到本地：

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

2. 安裝依賴項：

   pip install requests canvasapi
   

配置

環境變量設置

在項目的根目錄下創建一個 .env 文件，添加以下內容並替換為實際值：

CANVAS_API_TOKEN=your_api_token_here
CANVAS_BASE_URL=https://yourinstitution.canvaslms.com

運行服務器

啟動 MCP 服務器：

python mcp_server.py

✨ 主要特性

• 支持列出課程和獲取特定課程信息。
• 可與 Cursor IDE 集成，方便開發。
• 遵循標準的 Python 編碼規範，便於貢獻和維護。

📦 安裝指南

環境要求

• 操作系統：支持 Unix-like 系統（如 Linux 或 macOS）
• Python 版本：Python 3.8 或更高版本
• 依賴項：必須安裝 requests 和 canvasapi 庫

安裝步驟

1. 克隆此倉庫到本地：

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

2. 安裝依賴項：

   pip install requests canvasapi
   

💻 使用示例

基礎用法

常用命令

1. 列出課程：

   curl http://localhost:8000/api/courses
   

2. 獲取特定課程信息：

   curl http://localhost:8000/api/courses/12345
   

高級用法

與 Cursor 集成

快速開始

1. 安裝並啟動 Cursor IDE
2. 在項目目錄下創建 .cursor/mcp.json 文件，添加以下內容：

   {
       "mcpServers": {
           "canvas": {
               "command": "python",
               "args": ["mcp_server.py"],
               "env": {
                   "CANVAS_API_TOKEN": "your_api_token",
                   "CANVAS_BASE_URL": "https://yourinstitution.canvaslms.com"
               }
           }
       }
   }
   

示例用法

• 查詢即將到期的作業：

  What assignments are due soon?
  

• 查看特定課程的詳細信息：

  Show me the detailed information for course CS101.
  

📚 詳細文檔

開發指南

貢獻流程

1. 克隆倉庫：

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

2. 創建功能分支：

   git checkout -b feature/new-feature
   

3. 提交更改：

   git add .
   git commit -m "Add new functionality"
   git push origin feature/new-feature
   

代碼規範

• 遵循 PEP8 編碼規範。
• 提供詳細的文檔字符串和註釋。

📄 許可證

此項目遵循 MIT 協議。更多細節請查閱 LICENSE 文件。