Skip to main content

A minimal, auditable MCP server for editing Overleaf projects via Git

Project description

Overleaf MCP Server

Overleaf MCP Server

Edit your Overleaf projects from Claude.
Local, auditable, single-user by design.

PyPI Python versions License Tests


What it is

A local Model Context Protocol server that gives Claude five tools for working with an Overleaf project: list_projects, list_files, read_file, edit_file, sync. Every change goes through Overleaf's per-project Git remote, so the round-trip is Claude → MCP server → git push → Overleaf web UI.

What it is not

  • Not a replacement for Overleaf
  • Not a hosted multi-user service — single researcher, single Claude session, stdio transport
  • Not a LaTeX compiler — Overleaf still does the rendering
  • No branch / merge / diff tooling — use git directly for that
  • No real-time collaboration with humans editing in the Overleaf web UI at the same moment (use Overleaf's native real-time collab for that; the MCP server pulls before every write to stay honest, but doesn't subscribe to live updates)

If those constraints feel restrictive, that's deliberate — see the project notes for the design rationale.

Requirements

  • Python 3.11 or newer
  • A paid Overleaf account (Git integration is a paid feature)
  • An Overleaf Git authentication token: Overleaf web UI → Account Settings → Git Integration → New token
  • git on your PATH
  • git config user.name and git config user.email set globally (the server signs commits with this identity)

Install

pipx install overleaf-mcp-server

or with uv:

uv tool install overleaf-mcp-server

Either gives you the overleaf-mcp command.

Quick start

Interactive setup

# 1. Configure a project alias
overleaf-mcp init
#   Project alias (short nickname): my-paper
#   Overleaf project ID: 5f4a...           # from the project URL on overleaf.com
#   Display name (optional): My Paper

# 2. Store your Overleaf token in the OS keychain
overleaf-mcp auth add --project my-paper
#   Overleaf token: ****                    # paste, hidden input

# 3. Clone the project locally (one-time)
git clone https://git.overleaf.com/<project_id> ~/.cache/overleaf-mcp/my-paper

# 4. Verify
overleaf-mcp doctor

Scripted setup (v0.1.2+)

For provisioning scripts and CI, every prompt above has a flag-based equivalent:

# 1. Configure non-interactively (--alias engages non-interactive mode)
overleaf-mcp init \
    --alias my-paper \
    --project-id 5f4a... \
    --display-name "My Paper"
# add --force to overwrite an existing alias without prompting

# 2. Store the token via stdin (preferred — keeps it off the process command line)
printf '%s' "$OVERLEAF_TOKEN" | overleaf-mcp auth add --project my-paper --token-stdin

# or read from a named environment variable
overleaf-mcp auth add --project my-paper --token-from-env OVERLEAF_TOKEN

# 3. Clone the project (same as interactive)
git clone "https://x:${OVERLEAF_TOKEN}@git.overleaf.com/<project_id>" \
    ~/.cache/overleaf-mcp/my-paper

# 4. Verify
overleaf-mcp doctor

There is intentionally no --token VALUE flag. Values on the command line leak via ps; pipe through stdin or use an env var instead.

doctor prints a clean pass/fail report. If everything is green you're ready to wire up Claude Desktop.

Claude Desktop configuration

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows) and add:

{
  "mcpServers": {
    "overleaf": {
      "command": "overleaf-mcp",
      "args": ["serve"]
    }
  }
}

Fully quit and relaunch Claude Desktop (cmd-Q on macOS — closing the window isn't enough). In a new conversation, ask Claude something like "use overleaf list_projects" to verify.

Tools

Tool What it does
list_projects Lists configured Overleaf project aliases
list_files Lists files tracked in the project's git clone (optional extension filter)
read_file Reads a file from the project
edit_file Pulls latest, overwrites a file, commits, pushes to Overleaf
sync Pulls latest from Overleaf into the local clone

GitHub mirror (optional)

The MCP server only knows about your Overleaf remote. If you want a GitHub backup of a project, add it as a second remote on the local clone:

cd ~/.cache/overleaf-mcp/my-paper
git remote add github git@github.com:you/my-paper-mirror.git
git push github main

Then git push github main whenever you want to update the mirror, or wire up a cron / launchd job. The MCP server intentionally doesn't manage GitHub — that boundary keeps the server's surface small and the mirror under your control.

Security

  • Tokens are stored in the OS keychain (keyring library — macOS Keychain, Windows Credential Manager, libsecret on Linux). Never on disk.
  • The config file (~/.config/overleaf-mcp/config.toml) contains aliases and project IDs only — no secrets. Safe to put under version control if you really want to.
  • Subprocess git invocations pass tokens via env vars consumed by a transient GIT_ASKPASS script. Tokens never appear on the subprocess command line, so they don't show in ps.
  • The server only talks to git.overleaf.com and the local filesystem. No telemetry, no analytics, no other network traffic.

Limitations

  • Regex section parser. Handles \section, \subsection, \subsubsection (and starred variants) at the start of a line. Doesn't follow \input{} / \include{} across files, doesn't expand custom section macros, and doesn't parse titles with nested {} groups. Swap-in of a pylatexenc-backed parser is staged behind the abstract base class for a future minor release.
  • Single-user assumption. No locks, no concurrent-edit detection beyond git pull --ff-only (which fails fast if the local clone has diverged). Real-time collaboration with humans editing in the Overleaf web UI works because the server pulls before every write, but it's not a streaming sync.
  • stdio transport only in v0.1. HTTP/SSE for remote / multi-client setups is staged for v0.2.
  • No clone orchestration. doctor reports if the local clone is missing and prints the git clone command; the MCP server itself doesn't create or refresh the cache. Plain git is the right tool there.

Contributing

Bug reports and PRs welcome. See CLAUDE.md for project-local design notes if you're working on the server itself.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

overleaf_mcp_server-0.1.2.tar.gz (878.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

overleaf_mcp_server-0.1.2-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file overleaf_mcp_server-0.1.2.tar.gz.

File metadata

  • Download URL: overleaf_mcp_server-0.1.2.tar.gz
  • Upload date:
  • Size: 878.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for overleaf_mcp_server-0.1.2.tar.gz
Algorithm Hash digest
SHA256 81831189f54b2d774e77991e0206e9829ff370a2de8500fda0506fe27861f373
MD5 750dc97d8c1ef007ebfa7851ed6d8788
BLAKE2b-256 760d3d43f09215c3596e0a36b698fd63749f6754501de87f10bd2f38a6838cac

See more details on using hashes here.

Provenance

The following attestation bundles were made for overleaf_mcp_server-0.1.2.tar.gz:

Publisher: release.yml on amcheste/overleaf-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file overleaf_mcp_server-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for overleaf_mcp_server-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bbdb9e63fdbcf643ccd58d2c2e04211e4509c078acf69a0b2eb4bec36e6e58d4
MD5 4c84dbac5ba73b637a076c931c7e1f95
BLAKE2b-256 184e4a363920ff925a1bdc9bc9ca543c8cb7b9449de62fc54069c8610835efc0

See more details on using hashes here.

Provenance

The following attestation bundles were made for overleaf_mcp_server-0.1.2-py3-none-any.whl:

Publisher: release.yml on amcheste/overleaf-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page