Overleaf MCP Server
An MCP server that integrates with Overleaf's Git feature, allowing you to manage Overleaf projects directly from your MCP-enabled environment (like Cursor).
Features
- Clone Projects: Clone Overleaf projects to your local machine using the Project ID.
- Pull Changes: Sync latest changes from Overleaf to your local copy.
- Push Changes: Commit and push your local edits back to Overleaf.
- Get Status: Check the status of your local repository (modified files, etc.).
- Authentication Management: Securely configure and store your Overleaf Git credentials.
Installation
-
Clone this repository:
git clone https://github.com/juho127/overleafMCP.git cd overleafMCP -
Install dependencies:
npm install"args": ["/path/to/overleafMCP/build/index.js"] } } }
### Other Clients (e.g., Cursor)
For other MCP-supported clients like Cursor:
1. Go to **Settings** > **Features** > **MCP Servers**.
2. Click **+ Add New**.
3. Enter the command to run the server:
- Command: `node`
- Args: `/absolute/path/to/overleafMCP/build/index.js` (Replace with your actual path)
## Usage
### Authentication
Before using the git tools, you should configure your authentication. You can find your Git token in your Overleaf Account Settings.
**Tool**: `configure_auth`
- `email`: Your Overleaf email address.
- `token`: Your Overleaf Git token (or password).
### Cloning a Project
**Tool**: `clone_project`
- `projectId`: The ID from your Overleaf project URL (e.g., `65a1b2c3d4e5f6...`).
- `localPath`: Absolute path where you want to clone the project.
### Managing Changes
- **Pull**: Use `pull_changes` to get updates from Overleaf.
- **Status**: Use `get_status` to see what files you've changed.
- **Push**: Use `push_changes` to save your work back to Overleaf.
## License
MIT