MCP Server Canvas

🚀 畫布 MCP 服務器

本項目是一個用於 Canvas LMS API 的 Model Context Protocol (MCP) 服務器實現，能與 Canvas LMS 實用程序進行交互，為用戶提供便捷的操作體驗。

🚀 快速開始

該服務器為 Canvas LMS API 的 MCP 實現，若要使用此服務器，可按以下步驟操作：

# 克隆此倉庫
git clone <倉庫地址>

# 安裝依賴
npm install

# 設置環境變量
export CANVAS_BASE_URL="https://your-canvas-instance.com"
export CANVAS_ACCESS_TOKEN="your-api-token"

# 構建項目
npm run build

# 啟動服務器
npm start

✨ 主要特性

• 可列出 Canvas LMS 中的課程，還能通過 enrollment_type 進行過濾。
• 提供使用工具的交互式幫助提示，方便用戶操作。

📦 安裝指南

先決條件

• Node.js 18 或更高版本
• 一個 Canvas LMS 實例
• Canvas API 訪問令牌
• Cursor（用於客戶端集成）

安裝步驟

1. 克隆此倉庫。
2. 安裝依賴：

   npm install
   

3. 設置環境變量：

   export CANVAS_BASE_URL="https://your-canvas-instance.com"
   export CANVAS_ACCESS_TOKEN="your-api-token"
   

4. 構建項目：

   npm run build
   

5. 啟動服務器：

   npm start
   

💻 使用示例

基礎用法

與 Cursor 連接

要在 Cursor 中使用此 MCP 服務器，可按以下步驟操作：

1. 打開 Cursor 的設置。
2. 導航到 MCP 配置部分。
3. 添加新的服務器配置：

   {
     "mcpServers": {
       "canvas": {
         "command": "npm",
         "args": [
           "start"
         ],
         "cwd": "/path/to/mcp-server-canvas"
       }
     }
   }
   

4. 保存配置並重啟 Cursor。
5. 現在 Canvas 工具將在 Cursor 的 MCP 工具面板中可用。

高級用法

list_courses

列出 Canvas LMS 中的所有課程，可通過 enrollment_type 參數按選課類型（教師、學生、助教）過濾課程。

{
  "content": [
    {
      "type": "text",
      "text": [
        {
          "id": 1234,
          "name": "示例課程",
          "code": "EX101",
          "state": "可用",
          "startDate": "2024-01-01T00:00:00Z",
          "endDate": "2024-12-31T23:59:59Z"
        }
      ]
    }
  ]
}

list-courses-help

提供交互式提示以幫助使用 list_courses 工具。

📚 詳細文檔

開發

該服務器使用 TypeScript 和 MCP SDK 構建。若要添加新功能，可按以下步驟操作：

1. 向 CanvasAPI 類中添加新的 API 方法。
2. 使用 server.tool() 註冊新的工具。
3. 使用 server.prompt() 註冊交互式提示。
4. 構建並測試更改。

故障排除

遇到問題時，可按以下步驟排查：

1. 檢查環境變量是否正確設置。
2. 確認 Canvas API 令牌具有必要的權限。
3. 檢查 Cursor 的 MCP 服務器日誌中的錯誤消息。
4. 確保 Cursor 配置中的服務器路徑正確。

📄 許可證

本項目採用 MIT 許可證。