Skip to main content
Glama

canvas_file

Read-onlyIdempotent

Read Canvas file metadata and its download URL by file ID; use file_content to extract text from supported files.

Instructions

Read file metadata and its Canvas-provided download URL. Use file_content to extract supported text.

Input Schema

NameRequiredDescriptionDefault
rawNotrue: Canvas's unmodified JSON (UTC times, HTML).
pageNoPage to fetch: a number, or the next_page value returned by the previous call.
file_idYesCanvas file id, from canvas_files, canvas_find_files or a module item.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, so the safety profile is covered. The description adds that the payload includes a Canvas-provided download URL, which is useful, but says nothing about the pagination semantics implied by the page parameter or whether the URL expires.

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?

Two short sentences, front-loaded with what the tool returns and immediately followed by the alternative. Nothing is wasted or restated from the schema.

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?

With no output schema, the description correctly states what comes back (metadata plus download URL), and annotations cover safety. The remaining gap is minor: the sibling set contains several file-related tools and the description resolves only one of those collisions.

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% and every property (file_id, page, raw) carries its own documentation including the next_page bookmark convention. The description adds no meaning beyond the schema, which is the baseline-3 case.

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

Purpose4/5

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

Names a specific verb+resource ('Read file metadata and its Canvas-provided download URL') and explicitly delegates text extraction to file_content. It stops short of distinguishing itself from the sibling canvas_file_download_link, which also deals with download URLs, so an agent still has to guess between those two.

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?

The description gives one concrete routing rule: use file_content for extracting supported text. That is real when-to-use guidance against a close alternative, but there is no exclusion or guidance for canvas_file_download_link, canvas_file_original, or canvas_module_file.

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