Skip to main content
Glama
bruchris

Canvas LMS MCP Server

by bruchris
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List Course Submission Files

list_course_submission_files
Read-only

List every file attachment submitted by students across all assignments in a course. Returns a manifest — one entry per file — including the original filename, a file_id for re-fetching via download_file, content type, and size.

Instructions

List every file attachment submitted by students across all assignments in a course. Returns a manifest — one entry per file — including the original filename, a file_id for re-fetching via download_file, content type, and size. Useful for bulk-archiving student work before a course expires or a Free-For-Teacher account is concluded. Outputs are bounded by max_files (default 500); when the limit is hit, truncated is true and truncation_note explains how to retrieve the rest. Download URLs are time-limited (typically 1 hour) — use the returned file_id with download_file to get a fresh URL at download time. When CANVAS_PSEUDONYMIZE_STUDENTS is enabled, user_name is a stable per-course pseudonym (e.g. "Student 1"); user_id (the raw numeric Canvas ID) is always returned and works as a stable per-student folder key.

Input Schema

NameRequiredDescriptionDefault
course_idYesCanvas course ID.
max_filesNoMaximum number of file entries to return (1–2000). Default 500. When the limit is hit, truncated is set to true.
student_idsNoRestrict to these student user IDs. Omit to include all students. When CANVAS_PSEUDONYMIZE_STUDENTS is enabled, pass the real Canvas user_id after resolving the pseudonym via resolve_pseudonym.
assignment_idsNoRestrict to these assignment IDs. Omit to scan all assignments.
workflow_stateNoOnly include submissions in this workflow state. Omit to include all states.
attachments_onlyNoWhen true (default), skip submissions that have no file attachments. When false, still only emit file entries but process every submission.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv1.18.15
    • addedInput schema / properties / assignment_ids / items / anyOf
      Added value: +[
+  {
+    "exclusiveMinimum": 0,
+    "maximum": 9007199254740991,
+    "type": "integer"
+  },
+  {
+    "pattern": "^[1-9][0-9]{0,18}$",
+    "type": "string"
+  }
+]
    • removedInput schema / properties / assignment_ids / items / exclusiveMinimum
      Removed value: -0
    • removedInput schema / properties / assignment_ids / items / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / assignment_ids / items / type
      Removed value: -"integer"
    • addedInput schema / properties / course_id / anyOf
      Added value: +[
+  {
+    "exclusiveMinimum": 0,
+    "maximum": 9007199254740991,
+    "type": "integer"
+  },
+  {
+    "pattern": "^[1-9][0-9]{0,18}$",
+    "type": "string"
+  }
+]
    • removedInput schema / properties / course_id / exclusiveMinimum
      Removed value: -0
    • removedInput schema / properties / course_id / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / course_id / type
      Removed value: -"integer"
    • addedInput schema / properties / student_ids / items / anyOf
      Added value: +[
+  {
+    "exclusiveMinimum": 0,
+    "maximum": 9007199254740991,
+    "type": "integer"
+  },
+  {
+    "pattern": "^[1-9][0-9]{0,18}$",
+    "type": "string"
+  }
+]
    • removedInput schema / properties / student_ids / items / exclusiveMinimum
      Removed value: -0
    • removedInput schema / properties / student_ids / items / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / student_ids / items / type
      Removed value: -"integer"
  2. Changed1 schema field changedv1.18.11
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Addedv1.18.3

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the readOnly/openWorld annotations: it discloses the max_files bound and truncation contract (truncated, truncation_note), the time-limited (~1 hour) nature of download URLs and how to refresh them, and the pseudonymization behavior of user_name vs the always-stable user_id. This is exactly the behavioral context an agent needs.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose, then each subsequent sentence carries distinct, non-redundant information (return shape, use case, truncation, URL lifetime, pseudonymization). No filler sentences.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, yet the description describes the return manifest, the truncation signal, and the URL/pseudonym caveats, plus the safety profile is covered by annotations. An agent has everything needed to call and interpret this tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds cross-field meaning: max_files' truncation consequence, and the student_ids pseudonym-resolution requirement (resolve the pseudonym via resolve_pseudonym, then pass the real user_id). It also clarifies the file_id→download_file relationship, which the schema alone does not.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource with scope: 'List every file attachment submitted by students across all assignments in a course.' It is clearly distinguishable from siblings like list_files (general course files) and download_file (single fetch), and it explains the returned manifest's shape.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit use case ('bulk-archiving student work before a course expires or a Free-For-Teacher account is concluded') and routes re-fetching to download_file. It stops short of explicitly naming when to prefer list_files over this tool, so it is strong but not fully disambiguating.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools