Canvas MCP 服务器

一个用于 Canvas LMS API 的模型上下文协议 (MCP) 服务器实现。此服务器提供以编程方式与 Canvas LMS 交互的功能。

功能

• 从 Canvas LMS 列出课程，并可选择按注册类型进行过滤
• 使用工具的交互式帮助提示

前提条件

• 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 连接

要将此 MCP 服务器与 Cursor 一起使用：

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 (可选): 按注册类型过滤课程 (teacher, student, ta)

示例响应：

{
  "content": [
    {
      "type": "text",
      "text": [
        {
          "id": 1234,
          "name": "Example Course",
          "code": "EX101",
          "state": "available",
          "startDate": "2024-01-01T00:00:00Z",
          "endDate": "2024-12-31T23:59:59Z"
        }
      ]
    }
  ]
}

list-courses-help

一个交互式提示，提供有关使用 list_courses 工具的帮助。

开发

该服务器使用 TypeScript 和 MCP SDK 构建。要添加新功能：

1. 将新的 API 方法添加到 CanvasAPI 类
2. 使用 server.tool() 注册新工具
3. 使用 server.prompt() 注册帮助提示
4. 构建并测试您的更改

故障排除

如果您遇到问题：

1. 检查环境变量是否设置正确
2. 验证您的 Canvas API 令牌是否具有必要的权限
3. 检查 Cursor 的 MCP 服务器日志中是否有任何错误消息
4. 确保 Cursor 配置中的服务器路径正确

许可证

MIT