Skip to main content
Glama

overleaf_read_file

Reads LaTeX or text files from an Overleaf project by project ID, URL, or title; optionally saves raw binary content to a local path.

Instructions

Read a text/LaTeX file (.tex, .bib, .sty, .cls) from Overleaf or download a binary file locally.

Args: project: Overleaf project ID, project URL, or exact project title. remote_path: Path inside the Overleaf project (e.g. 'main.tex' or 'sections/intro.tex'). save_to_path: Optional local file path to save raw bytes (required for binary files like PDFs/images).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project": "<project>",
      "remote_path": "<remote_path>"
    },
    "name": "overleaf_read_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectYes
remote_pathYes
save_to_pathNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.6/5.0
Behavior3/5

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

No annotations exist, so the description carries the full burden. It usefully discloses the dual text-vs-binary behavior and the save_to_path requirement for binaries, but says nothing about authentication requirements, behavior on missing paths, whether binary content is returned inline or only written to disk, or rate/size limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action in the first sentence, then a compact Args block with no filler. The Args list is appropriate here precisely because the schema carries no descriptions, though the format is plain docstring style rather than integrated prose.

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?

An output schema exists, so return values need not be explained, and the three parameters are fully covered in the description. For a simple read/download tool this is nearly complete; the gap is auth and failure behavior, which is partly addressed by the existence of overleaf_auth_status but never mentioned.

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 description coverage is 0%, so the description must supply all parameter meaning — and it does: project accepts an ID, URL, or exact title; remote_path is illustrated with 'main.tex' and 'sections/intro.tex'; save_to_path is described as optional raw-bytes output. Only missing detail is whether remote_path is project-relative root anchored.

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?

States a specific verb and resource ('Read a text/LaTeX file... from Overleaf') and even enumerates the relevant extensions (.tex, .bib, .sty, .cls), plus the alternate binary-download behavior. It does not explicitly contrast itself with overleaf_list_files or overleaf_write_file, so it stops short of full sibling differentiation.

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

Usage Guidelines3/5

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

The description implies when this applies (reading known paths, or downloading a binary that must be saved locally) and flags that save_to_path is required for binary files. However, it gives no explicit guidance on choosing this over overleaf_list_files to discover paths, or over overleaf_pull_project for bulk retrieval.

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