Skip to main content
Glama

canvas_module_file_content

Read-onlyIdempotent

Extracts readable text from a Canvas module file item or linked Google Drive, Dropbox, GitHub, or direct file using Canvas IDs, with pagination, character limits, and ZIP entry selection.

Instructions

Read the TEXT of a module item: a Canvas File item (same as canvas_file_content), or an ExternalUrl item linking to a file on another site: Google Docs, Slides and Sheets, Google Drive files, Dropbox files and folders, GitHub files and repositories, or a direct link to a PDF/Office/ZIP/code file. Google and Dropbox files must be shared publicly ("Anyone with the link"). Takes Canvas IDs only, never a URL. Same text options as canvas_file_content (offset, max_chars, entry for ZIPs). For the original file itself use canvas_module_file.

Input Schema

NameRequiredDescriptionDefault
entryNoZIP only: path of one file inside the archive, exactly as shown in the listing.
offsetNoCharacter to start reading from; pass next_offset from the previous call to continue.
item_idYesModule item id, from canvas_module_items.
course_idYesCanvas course id, from canvas_courses.
max_charsNoMost characters of text to return in this call (default 20000).
module_idYesModule id, from canvas_modules.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and open-world behavior, so the bar is lower; the description still adds real value by naming the public-sharing prerequisite and the external-link failure mode. It also discloses the ZIP-entry and offset continuation model. It does not describe truncation/next_offset behavior explicitly, which is the main remaining behavioral gap.

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

Conciseness4/5

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

The purpose is front-loaded in the first clause and the enumeration of supported sites is scoped appropriately. The cross-reference 'Same text options as canvas_file_content' is mildly wasteful since it pushes the reader to another tool's docs.

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

Completeness4/5

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

No output schema exists, and the description covers input preconditions, the read-only nature, and where to get IDs indirectly via the schema's 'from canvas_module_items'-style hints. With six parameters at full schema coverage, this is close to sufficient; only the pagination/truncation contract is left unstated.

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

Parameters3/5

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

Schema description coverage is 100%, so the baseline is 3, and the description only restates the parameter names already documented in the schema ('offset, max_chars, entry for ZIPs'). It adds no format, default, or range detail beyond the schema, so it earns no credit above baseline.

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 ('Read the TEXT') against a precisely scoped resource (a module item that is either a Canvas File item or an ExternalUrl item) and enumerates the supported link targets. It distinguishes itself from named siblings (canvas_file_content, canvas_link_content, canvas_module_file) so an agent can route without opening schemas.

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 clear context plus explicit exclusions: 'For the original file itself use canvas_module_file' and 'Takes Canvas IDs only, never a URL.' It also states a prerequisite ('Google and Dropbox files must be shared publicly'). It stops short of telling the agent when this is preferred over canvas_file_content, only that they behave the same.

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