download_project_zip
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
| Name | Required | Description | Default |
|---|---|---|---|
| localPath | Yes | Local file to write the archive to, for example backup.zip | |
| overwrite | No | Replace localPath if it already exists | |
| projectId | Yes | Overleaf project ID | |
| timeoutMs | No | Limit for the whole download; defaults to 5 minutes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bytes | Yes | ||
| replaced | Yes | ||
| localPath | Yes | ||
| projectId | Yes |