Provides access to Overleaf projects via Git integration, enabling reading of LaTeX files, document structure analysis, content extraction by section, and project management capabilities across multiple Overleaf projects.
βI tried to argue with Overleaf, but it said my syntax was invalid.β
Overleaf MCP Server
An MCP (Model Context Protocol) server that gives Claude and other MCP clients access to Overleaf projects through Git integration. It can read LaTeX files, parse structure, and extract content , basically letting AI peek under the hood of your papers (ethically, of course). π§
π Repo: https://github.com/GhoshSrinjoy/Overleaf-mcp
Executive Summary
This server bridges Overleaf and AI models through MCP. It lets clients list, read, and analyze LaTeX files as if Overleaf were a local workspace.
Everythingβs Git-based, so you get versioned, safe access. A Redis queue manages concurrency, keeping multiple project operations from stepping on each other.
In short: Itβs Overleaf β Git β Redis β MCP β Claude (or any client).
Business Problem
Overleaf is great for collaboration, but hard to integrate with tools like Claude or LLM-based assistants. You either:
copy-paste LaTeX manually, or
mess with API endpoints and tokens in ways that donβt scale.
This MCP server makes Overleaf βAI-readable.β It lets LLMs fetch content, inspect sections, and summarize papers without exposing tokens or corrupting repos. Perfect for research groups, AI note-takers, or publishing workflows.
Methodology
How it works
Uses Overleafβs Git integration to clone and sync projects.
Reads file trees and parses
.texdocuments for sections, subsections, and content.Dispatches jobs through a Redis-backed BullMQ queue.
Each project gets its own Redis lock to prevent race conditions.
Returns clean structured data through the MCP protocol.
Key features
π File management (list/read Overleaf files)
π Document structure parsing (sections & subsections)
π Content extraction (get specific section by title)
π Project summary (status, structure overview)
ποΈ Multi-project support
βοΈ Redis-backed queue for concurrency safety
Installation
Clone this repository
Install dependencies:
npm installSet up your projects configuration:
cp projects.example.json projects.jsonEdit
projects.jsonwith your Overleaf credentials:{ "projects": { "default": { "name": "My Paper", "projectId": "YOUR_OVERLEAF_PROJECT_ID", "gitToken": "YOUR_OVERLEAF_GIT_TOKEN" } } }Start a Redis instance (locally or remotely). For example:
docker compose up redis -dRun the MCP server:
npm start
Getting Overleaf Credentials
Git Token:
Go to Overleaf Account Settings β Git Integration
Click "Create Token"
Project ID:
Open your Overleaf project
Find it in the URL:
https://www.overleaf.com/project/[PROJECT_ID]
Configuration & Environment
The server coordinates all tool calls through a Redis-backed BullMQ queue. Heavy Git operations are serialized per project using Redis locks to avoid repository corruption while still allowing concurrent work across different projects.
Key environment variables:
PROJECTS_FILE: Path to the Overleaf project map (default:./projects.json).OVERLEAF_TEMP_DIR: Cache directory for cloned repositories (default:./temp).REDIS_URLorREDIS_HOST/REDIS_PORT/REDIS_PASSWORD/REDIS_DB: Redis connection details.REQUEST_QUEUE_NAME: Override the BullMQ queue name (default:overleaf-mcp-requests).REQUEST_CONCURRENCY: Worker concurrency for queued jobs (default:4).REQUEST_TIMEOUT_MS: Maximum time the server waits for a job to finish (default:120000).PROJECT_LOCK_TTL_MS,PROJECT_LOCK_RETRY_MS,PROJECT_LOCK_MAX_WAIT_MS: Advanced tuning for per-project Redis locks.OVERLEAF_GIT_TOKEN,OVERLEAF_PROJECT_ID: Optional environment fallbacks if they are not defined inprojects.jsonor tool arguments.
Claude Desktop Setup
Add to your Claude Desktop configuration file:
Windows: %APPDATA%\Claude\claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Linux: ~/.config/claude/claude_desktop_config.json
Option 1: Node.js Direct (Local Development)
Requirements: Node.js installed locally, Redis running locally, all dependencies installed via npm install.
Option 2: Docker Compose (Recommended for Production)
Requirements: Docker and Docker Compose installed, project built with docker compose build.
Benefits: Isolated environment, automatic Redis management, ephemeral containers.
Option 3: Docker Exec (Persistent Container)
Example with specific container name:
Requirements:
Containers already running via
docker compose up -dReplace
CONTAINER_NAMEwith your actual container name (find withdocker ps)Container must remain running for MCP to work
When to use each approach:
Option 1: Development and debugging
Option 2: Clean, isolated production deployments
Option 3: When you want persistent containers and direct execution control
Restart Claude Desktop after configuration.
Docker Usage
You can run the MCP server and its Redis dependency entirely in containers using the provided compose file.
Basic Docker Setup
Copy
projects.example.jsontoprojects.jsonand fill in your credentials.(Optional) Create a cache directory so clones persist across runs:
mkdir -p data/cacheBuild the containers:
docker compose buildStart both Redis and MCP containers:
docker compose up -d
Advanced Docker Usage
For ephemeral containers (Option 2 above):
For persistent containers (Option 3 above):
The compose service maps projects.json into the container at /app/projects.json, and stores cloned repos under ./data/cache on the host.
Use docker compose down when you want to stop all containers.
Container Management
View container logs:
Troubleshooting container names:
Available Tools
list_projects
List all configured projects.
list_files
List files in a project (default: .tex files).
extension: File extension filter (optional)projectName: Project identifier (optional, defaults to "default")
read_file
Read a specific file from the project.
filePath: Path to the file (required)projectName: Project identifier (optional)
get_sections
Get all sections from a LaTeX file.
filePath: Path to the LaTeX file (required)projectName: Project identifier (optional)
get_section_content
Get content of a specific section.
filePath: Path to the LaTeX file (required)sectionTitle: Title of the section (required)projectName: Project identifier (optional)
status_summary
Get a comprehensive project status summary.
projectName: Project identifier (optional)
Usage Examples
Multi-Project Usage
To work with multiple projects, add them to projects.json:
Then specify the project in tool calls:
File Structure
Troubleshooting
Common Issues
"Server disconnected" in Claude Desktop:
Check container names with
docker psVerify containers are running with
docker compose psCheck Redis connection with
docker compose logs redis
"Project does not exist" error:
Verify Project ID in your Overleaf URL
Check Git Token is valid and not expired
Ensure Git integration is enabled in Overleaf project settings
Redis connection errors:
Ensure Redis container is running:
docker compose up -d redisCheck Redis logs:
docker compose logs redis
Container name mismatch (Option 3 users):
Find correct container name:
docker ps --format "table {{.Names}}"Update Claude Desktop config with exact container name
Container names may include project directory prefix (e.g.,
overleaf_mcp-mcp-1)
Why Redis is Important
Redis provides several critical functions:
Queue Management: Handles multiple simultaneous requests without blocking
Project Locking: Prevents Git conflicts when multiple operations access the same project
Worker Pool Management: Distributes workload across multiple worker processes
Production Readiness: Makes the server scalable and robust for concurrent usage
Without Redis, the server would work for single-user scenarios but could face race conditions and resource exhaustion under load.
Security Notes
projects.jsonis gitignored to protect your credentialsNever commit real project IDs or Git tokens
Use the provided
projects.example.jsonas a templateContainer logs may contain sensitive information - secure appropriately
Citation
If you use this software in your research, please cite:
Skills
This project touches on: Node.js, Redis (BullMQ), Docker, Overleaf Git integration, file parsing (LaTeX), concurrent job queues, and MCP protocol design.
It also demonstrates practical engineering for AI Γ research integration β building bridges between human writing tools and model understanding. π§©
Results & Business Recommendation
What it delivers
Seamless Overleaf access for Claude and other MCP clients.
Structured reading of LaTeX files and sections.
Scalable multi-project handling via Redis queues.
No need to expose Overleaf APIs publicly or store plaintext tokens.
Best for:
Research labs building paper assistants or summarizers.
AI tools integrating academic context.
Developers needing safe, concurrent Overleaf sync.
Recommendation:
Use Docker Compose (Option 2) for production : it keeps Redis and the MCP server isolated and persistent.
For local testing, Node Direct (Option 1) is enough.
Option 3 (Docker Exec) is great when you want persistent containers and direct control. π―
Next Steps
π§ Add smarter section extraction using regex or tree-based parsing.
π§΅ Add worker scaling for large document sets.
π Add encryption for cached repositories.
π§© Extend support for Markdown and BibTeX parsing.
π¦ Publish a prebuilt Docker image to Docker Hub.
π§° Add CI tests for Redis + lock integrity.
π€ Add optional Claude prompts for βauto-summarize LaTeX sections.β
MIT License