Skip to main content
Glama

ZeroWidth

Read a file from the workspace

workspace_files_read
Read-only

Read an uploaded file (PDF, Word, PowerPoint, spreadsheet, text) as markdown. Find file ids with workspace_folders_browse (a folder's items of kind workspace_file) or search_workspace. For anything long, call with outline: true first: it returns the headings with their character offsets and the total length. Then read only the sections you need with offset and maxChars. Spreadsheets come back as tables. A file that can't be read as text says so; don't guess at its contents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileIdYes
offsetNoCharacter offset to start from. Default 0.
outlineNoReturn the headings and their offsets instead of text.
maxCharsNoHow much to return. Default 12000.
workspaceNoWorkspace slug. Ignored when the workspace is already set.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds valuable behavior: outline returns headings with offsets and total length, spreadsheets render as tables, and unreadable files report failure rather than being guessed at. It stops short of describing pagination limits or exact return shape.

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?

Five dense sentences, front-loaded with purpose, then id lookup, then the outline-to-section strategy, then format edge cases. No filler; every sentence changes how the agent calls the tool.

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 must carry return-value meaning, and it does explain markdown output, heading/offset outlines, and table rendering. Minor gaps remain around default sizes and maxChars cap, which are inferable from the schema.

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 80% (fileId is undocumented anywhere). The description nonetheless gives operational meaning to outline, offset, and maxChars by explaining they form a progressive-read workflow, adding intent beyond the schema's terse field notes.

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) plus resource (uploaded file) and the output format (as markdown), even enumerating supported file types. An agent can immediately distinguish this from save/list/browse siblings.

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

Usage Guidelines5/5

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

Explicitly routes the agent: file ids come from workspace_folders_browse or search_workspace, and for long files it prescribes outline:true first, then targeted reads with offset/maxChars. This is when-and-how guidance rather than mere context.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources