跳到主要内容

Canvas

Canvas LMS 集成 — 使用 API 令牌认证获取已注册的课程和作业。

技能元数据​

来源可选 — 使用 hermes skills install official/productivity/canvas 安装
路径optional-skills/productivity/canvas
版本1.0.0
作者community
许可证MIT
标签Canvas, LMS, Education, Courses, Assignments

参考：完整 SKILL.md​

信息

以下是 Hermes 在触发此技能时加载的完整技能定义。这是技能激活时代理所看到的指令。

Canvas LMS — 课程与作业访问

对 Canvas LMS 的只读访问权限，用于列出课程和作业。

脚本​

  • scripts/canvas_api.py — 用于 Canvas API 调用的 Python CLI

设置​

  1. 在浏览器中登录到你的 Canvas 实例
  2. 前往 Account → Settings（点击你的个人资料图标，然后选择 Settings）
  3. 滚动到 Approved Integrations 并点击 + New Access Token
  4. 为令牌命名（例如，“Hermes Agent”），设置可选的过期时间，然后点击 Generate Token
  5. 复制令牌并将其添加到 ~/.hermes/.env：
CANVAS_API_TOKEN=your_token_here
CANVAS_BASE_URL=https://yourschool.instructure.com

基础 URL 是你登录 Canvas 时在浏览器中显示的地址（末尾不带斜杠）。

用法​

CANVAS="python $HERMES_HOME/skills/productivity/canvas/scripts/canvas_api.py"

# List all active courses
$CANVAS list_courses --enrollment-state active

# List all courses (any state)
$CANVAS list_courses

# List assignments for a specific course
$CANVAS list_assignments 12345

# List assignments ordered by due date
$CANVAS list_assignments 12345 --order-by due_at

输出格式​

list_courses 返回：

[{"id": 12345, "name": "Intro to CS", "course_code": "CS101", "workflow_state": "available", "start_at": "...", "end_at": "..."}]

list_assignments 返回：

[{"id": 67890, "name": "Homework 1", "due_at": "2025-02-15T23:59:00Z", "points_possible": 100, "submission_types": ["online_upload"], "html_url": "...", "description": "...", "course_id": 12345}]

注意：作业描述被截断为 500 个字符。html_url 字段链接到 Canvas 中的完整作业页面。

API 参考 (curl)​

# List courses
curl -s -H "Authorization: Bearer $CANVAS_API_TOKEN" \
  "$CANVAS_BASE_URL/api/v1/courses?enrollment_state=active&per_page=10"

# List assignments for a course
curl -s -H "Authorization: Bearer $CANVAS_API_TOKEN" \
  "$CANVAS_BASE_URL/api/v1/courses/COURSE_ID/assignments?per_page=10&order_by=due_at"

Canvas 使用 Link 头进行分页。Python 脚本会自动处理分页。

规则​

  • 此技能为 只读 — 它仅获取数据，从不修改课程或作业
  • 首次使用时，通过运行 $CANVAS list_courses 验证身份验证 — 如果因 401 错误失败，请指导用户完成设置
  • Canvas 的速率限制约为每 10 分钟 700 次请求；如果达到限制，请检查 X-Rate-Limit-Remaining 头

故障排除​

问题解决方法
401 Unauthorized令牌无效或已过期 — 在 Canvas 设置中重新生成
403 Forbidden令牌缺乏对此课程的权限
课程列表为空尝试使用 --enrollment-state active 或省略该标志以查看所有状态
机构错误验证 CANVAS_BASE_URL 是否与浏览器中的 URL 匹配
超时错误检查到你的 Canvas 实例的网络连接