Skip to main content
Glama

Read File

read_file
Read-onlyIdempotent

Download Canvas files and extract text from PDF, DOCX, PPTX, or plain text to read lecture slides, notes, and readings. Get file IDs from list_files or course_content.

Instructions

Download a Canvas file and return its text (lecture slides, notes, readings). Supports PDF, DOCX, PPTX, and plain text. Get file ids from list_files or course_content. Long files are truncated to max_chars.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
file_idYesCanvas file id, from list_files
max_charsNoTruncate extracted text to this length

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Annotations already provide readOnlyHint=true and destructiveHint=false, so the safety profile is known. The description adds useful behavioral context about supported formats (PDF, DOCX, PPTX, plain text) and truncation behavior ('Long files are truncated to max_chars'), which goes beyond what annotations state and helps set expectations.

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?

Three succinct sentences deliver the core purpose, supported formats, source of ids, and truncation limit. Every sentence earns its place, and the description is front-loaded with the primary action and outcome.

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?

For a straightforward read tool with strong annotations and an existing output schema, the description covers the essential operational details: file types, id sourcing, and truncation. Minor gaps include error handling or exact return format, but these are adequately compensated by the schema and annotations.

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%, with both file_id and max_chars already documented. The description reinforces the source of file_id (from list_files) and the role of max_chars in truncation, but does not significantly enhance the schema's clarity. Baseline 3 is appropriate when the schema already carries the semantic load.

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?

The description uses a specific verb ('Download') and clearly states the resource ('Canvas file') and the outcome ('return its text'). It lists example content types (lecture slides, notes, readings) and distinguishes itself from siblings like list_files and get_page by focusing on file content extraction.

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 clearly indicates a prerequisite: get file ids from list_files or course_content, which tells the agent when to use this tool. It does not explicitly mention alternatives or exclusions, but the context is specific enough for effective selection among sibling reading tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/JohannsenLum/canvas-api-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server