Skip to main content
Glama

Read a project file

read_file
Read-only

Read an editable project file or return a 10-minute signed download URL for a private project asset. Provide exactly one target: fileId or path. For a localized task in a large text file, pass lineRange with inclusive 1-based startLine and endLine values to return at most 400 lines, absolute UTF-16 offsets, and a revision-bound rangeToken. If replacing all returned source lines, pass that rangeToken to edit_file instead of retyping the old text. Refine lineRange first when only part of the returned range should change. Omit lineRange when the full file is required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNo
fileIdNo
lineRangeNo
projectIdYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYes
rangeNo
contentNo
downloadUrlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

The description adds valuable behavioral details beyond the annotations: the 10-minute expiry of the download URL, the 400-line limit, absolute UTF-16 offsets, and revision-bound rangeToken. This goes beyond the readOnlyHint and provides concrete 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?

Four sentences, each with a distinct purpose, front-loaded with the core functionality, and no redundant information. The structure flows from general to specific use cases efficiently.

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?

The description covers the main usage scenarios, including the alternative to edit_file, and given the output schema exists, it is complete for an agent to call correctly. Minor gaps like error handling are not specified but are not critical for basic invocation.

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?

With 0% schema description coverage, the description compensates by explaining the oneOf constraint (exactly one target: fileId or path) and detailing lineRange's inclusive 1-based startLine/endLine and its effects. projectId is not explained but is a required UUID and its purpose is self-evident.

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 clearly states the tool reads an editable project file or returns a signed download URL, and distinguishes it from sibling tools like edit_file and list_files by specifying the read-only nature and two distinct output modes.

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?

It provides explicit guidance on when to use lineRange for localized tasks, when to omit it for full files, and when to pass the rangeToken to edit_file. It does not explicitly exclude list_files, but the purpose is clear and the main alternatives are addressed.

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