Skip to main content
Glama

overleaf_upload_folder

Uploads a local directory recursively to an Overleaf project via web session or Git Bridge push, with options for target subfolders, ignore patterns, and removing deleted files.

Instructions

Upload an entire local directory (recursively) to an existing Overleaf project.

Supports both Web Session upload (works on Free & Paid accounts) and Git Bridge push (Paid/Institutional).

Args: project: Overleaf project ID, project URL, or exact project title. local_dir: Local folder whose contents will be uploaded. remote_dir: Optional target subdirectory in Overleaf (Web mode; e.g. 'figures'). Empty uploads to project root. method: 'web' (session cookie API), 'git' (Git Bridge commit & push), or 'auto' (prefers 'git' when token + root upload, else 'web'). commit_message: Git commit message when using method='git'. delete_missing_in_git: In 'git' mode, remove remote files that no longer exist in local_dir. ignore_patterns: Optional filename/directory globs to ignore (defaults skip .git, .DS_Store, *.aux, etc.).

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>",
      "local_dir": "<local_dir>"
    },
    "name": "overleaf_upload_folder"
  }
}

Input Schema

NameRequiredDescriptionDefault
methodNoauto
projectYes
local_dirYes
remote_dirNo
commit_messageNoSync folder via Overleaf MCP Agent
ignore_patternsNo
delete_missing_in_gitNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations at all, the description carries the full burden and does well: it discloses account-tier requirements per method, warns that delete_missing_in_git removes remote files absent locally, and states the default ignore set. It does not say whether that deletion is recoverable or what auth state is required beforehand, so this is strong but not complete.

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 one sentence stating the action, followed by a method summary and a tight Args list where each line adds information. The Args formatting is efficient, though the docstring style is slightly heavier than a compact prose description would be.

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?

A 7-parameter mutation tool with no annotations is a high bar, and the description covers every parameter, the mode tradeoffs, and the destructive default-off flag. Return values are covered by the output schema, so the only real gap is prerequisites such as required auth and the irreversibility of git deletions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate, and it does: project accepts an ID, URL, or exact title; remote_dir is Web-mode only and empty means project root; auto resolves to git only under token + root conditions; ignore_patterns have sensible defaults. That is meaning well beyond the bare property names in the schema.

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 ('Upload an entire local directory (recursively) to an existing Overleaf project'), and the recursive-directory framing implicitly separates it from the single-file sibling overleaf_upload_file. It never names a sibling explicitly, so differentiation is by inference rather than by statement.

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?

Gives concrete selection logic: 'web' works on Free & Paid accounts, 'git' is Paid/Institutional, and 'auto' prefers git when a token and root upload are present. That is real when-to-use guidance, though it does not say when to prefer this tool over overleaf_git_sync or overleaf_upload_file, and lists no exclusions.

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