Skip to main content
Glama

download_project_zip

Destructive

Download a full Overleaf project, sources and binaries, as one zip archive to a local path. Use it to back up a project before overwriting or syncing files.

Instructions

Download the whole project, sources and binaries, as one zip archive (Overleaf's "Download as zip") to a local path on the server's own disk. The folder must exist. An existing file is replaced only when overwrite is true, else CONFIRMATION_MISMATCH and nothing is downloaded; a replacement is atomic, so a failed or incomplete download leaves the old file intact. Offer it as a backup before a mirror sync_directory or an overwriting batch_upload. Overleaf allows about 10 downloads per project a minute, so on RATE_LIMITED wait a minute. PERMISSION_DENIED here can also mean the session expired; check auth_status. Returns the absolute localPath, bytes, and replaced.

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": {
      "projectId": "<projectId>",
      "localPath": "<localPath>"
    },
    "name": "download_project_zip"
  }
}

Input Schema

NameRequiredDescriptionDefault
localPathYesLocal file to write the archive to, for example backup.zip
overwriteNoReplace localPath if it already exists
projectIdYesOverleaf project ID
timeoutMsNoLimit for the whole download; defaults to 5 minutes

Output Schema

NameRequiredDescriptionDefault
bytesYes
replacedYes
localPathYes
projectIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A4.6/5.0
Behavior4/5

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

Goes well past the annotations by disclosing that the parent folder must already exist, that an existing file is only replaced when overwrite is true, that a mismatch returns CONFIRMATION_MISMATCH with nothing downloaded, that replacement is atomic so a failed download leaves the old file intact, and the ~10/minute per-project rate limit. The only shortfall is that it does not say what the atomic write does on disk (temp file naming) or how long partial state may linger.

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 purpose, then preconditions, failure semantics, usage advice, and error recovery – each sentence carries a distinct fact. It is dense but nearly every clause earns its place; only the parenthetical Overleaf feature name is strictly redundant.

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?

For a write-capable download tool with four parameters and an output schema, the description covers preconditions, overwrite/atomicity behavior, rate limits, and error recovery. Return values are already covered by the output schema, so its brief mention of localPath/bytes/replaced is sufficient.

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 100%, so the baseline is 3, but the description adds real meaning beyond it: the precondition that the destination folder must exist, and the consequence of overwrite=false (CONFIRMATION_MISMATCH, no download) versus true (atomic replacement). It does not add detail on timeoutMs beyond what the schema already documents.

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 (download) and resource (the whole project, sources and binaries) as a single zip, and explicitly ties it to Overleaf's "Download as zip" feature. The scope word "whole" implicitly separates it from download_file and download_compile_output, so an agent can pick it without opening the schema.

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?

Gives a concrete when-to-use recommendation (as a backup before a mirror sync_directory or an overwriting batch_upload) and maps two error paths to next actions: wait a minute on RATE_LIMITED, and check auth_status when PERMISSION_DENIED may mean an expired session.

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