MCP Server Canvas

🚀 画布 MCP 服务器

画布 MCP 服务器是一个基于 Model Context Protocol (MCP) 的实现，专为 Canvas LMS API 打造。它提供了与 Canvas LMS 实用程序进行交互的功能，让用户能够更便捷地管理和使用 Canvas LMS 中的资源。

🚀 快速开始

要使用画布 MCP 服务器，你需要完成以下步骤：

1. 确保满足先决条件。
2. 按照设置步骤进行安装和配置。
3. 连接到 Cursor（如果需要）。

✨ 主要特性

• 课程列表功能：能够列出 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 许可证。