Skip to main content
Glama

Read source files

read_files
Read-onlyIdempotent

Read exact current source files for an app created by deploy_files. Pass paths from list_files. Text is bounded and resumable with next_offset; binary content is never returned.

Input Schema

NameRequiredDescriptionDefault
pathsYesone to fifty exact relative file paths returned by list_files
offsetNobyte offset for continuing one truncated file; only valid with a single path
project_idYesthe managed project id (from list_projects)

Output Schema

NameRequiredDescriptionDefault
filesYes
commitYes
project_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare this as a safe, read-only, idempotent operation. The description adds useful behavioral context beyond annotations: text is bounded, reads can be resumed, and binary content is never returned. The only minor gap is the use of 'next_offset' while the input parameter is named 'offset'.

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?

The description is two tight sentences with no wasted language. It front-loads the core action and follows with the key constraints and sibling reference.

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

Completeness5/5

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

Given the simple three-parameter schema, full schema coverage, annotations, and an output schema, the description is complete enough for correct invocation. It covers provenance of paths, bounded/resumable reads, and the binary-content limitation.

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 schema already documents paths, offset, and project_id. The description reinforces provenance by saying paths should come from list_files, but it does not add substantial parameter semantics beyond the schema.

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 states a specific verb and resource: reading exact current source files. It also scopes the tool to an app created by deploy_files and distinguishes it from list_files by requiring paths from that sibling.

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 gives clear usage context: use paths returned by list_files and target an app created by deploy_files. It does not explicitly state when not to use it or name alternatives beyond list_files, so it falls short of a 5.

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