Overleafmcp

🚀 Overleaf MCP 服務器

這是一個 MCP（模型上下文協議）服務器，通過 Git 集成提供對 Overleaf 項目的訪問。它允許 Claude 及其他 MCP 客戶端讀取 LaTeX 文件、分析文檔結構並從 Overleaf 項目中提取內容。

✨ 主要特性

• 📄 文件管理：列出並讀取 Overleaf 項目中的文件
• 📋 文檔結構解析：解析 LaTeX 文件的章節和子章節
• 🔍 內容提取：按標題提取特定章節的內容
• 📊 項目概述：獲取項目狀態和結構的概覽
• 🏗️ 多項目支持：管理多個 Overleaf 項目

📦 安裝指南

1. 克隆此倉庫
2. 安裝依賴：

   npm install
   

3. 設置項目配置：

   cp projects.example.json projects.json
   

4. 使用你的 Overleaf 憑證編輯 projects.json：

   {
     "projects": {
       "default": {
         "name": "My Paper",
         "projectId": "YOUR_OVERLEAF_PROJECT_ID",
         "gitToken": "YOUR_OVERLEAF_GIT_TOKEN"
       }
     }
   }
   

獲取 Overleaf 憑證

1. Git 令牌：
   • 進入 Overleaf 賬戶設置 → Git 集成
   • 點擊“創建令牌”
2. 項目 ID：
   • 打開你的 Overleaf 項目
   • 在 URL 中找到：https://www.overleaf.com/project/[PROJECT_ID]

Claude 桌面端設置

將以下內容添加到你的 Claude 桌面端配置文件中：

• Windows：%APPDATA%\Claude\claude_desktop_config.json
• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Linux：~/.config/claude/claude_desktop_config.json

{
  "mcpServers": {
    "overleaf": {
      "command": "node",
      "args": [
        "/path/to/OverleafMCP/overleaf-mcp-server.js"
      ]
    }
  }
}

配置完成後重啟 Claude 桌面端。

可用工具

list_projects

列出所有配置的項目。

list_files

列出項目中的文件（默認：.tex 文件）。

• extension：文件擴展名過濾器（可選）
• projectName：項目標識符（可選，默認為 "default"）

read_file

讀取項目中的特定文件。

• filePath：文件路徑（必需）
• projectName：項目標識符（可選）

get_sections

獲取 LaTeX 文件中的所有章節。

• filePath：LaTeX 文件的路徑（必需）
• projectName：項目標識符（可選）

get_section_content

獲取特定章節的內容。

• filePath：LaTeX 文件的路徑（必需）
• sectionTitle：章節標題（必需）
• projectName：項目標識符（可選）

status_summary

獲取項目的綜合狀態概覽。

• projectName：項目標識符（可選）

💻 使用示例

基礎用法

# 列出所有項目
使用 list_projects 工具

# 獲取項目概覽
使用 status_summary 工具

# 讀取 main.tex 文件
使用 read_file 工具，指定 filePath 為 "main.tex"

# 獲取 Introduction 章節
使用 get_section_content 工具，指定 filePath 為 "main.tex" 且 sectionTitle 為 "Introduction"

# 列出文件中的所有章節
使用 get_sections 工具，指定 filePath 為 "main.tex"

多項目使用

若要處理多個項目，可將它們添加到 projects.json 中：

{
  "projects": {
    "default": {
      "name": "Main Paper",
      "projectId": "project-id-1",
      "gitToken": "token-1"
    },
    "paper2": {
      "name": "Second Paper", 
      "projectId": "project-id-2",
      "gitToken": "token-2"
    }
  }
}

然後在工具調用中指定項目：

使用 get_section_content 工具，指定 projectName 為 "paper2"，filePath 為 "main.tex"，sectionTitle 為 "Methods"

文件結構

OverleafMCP/
├── overleaf-mcp-server.js    # 主 MCP 服務器
├── overleaf-git-client.js    # Git 客戶端庫
├── projects.json             # 你的項目配置（已添加到 .gitignore）
├── projects.example.json     # 示例配置
├── package.json              # 依賴項
└── README.md                 # 本文件

安全注意事項

⚠️ 重要提示

• projects.json 已添加到 .gitignore 以保護你的憑證
• 切勿提交真實的項目 ID 或 Git 令牌
• 使用提供的 projects.example.json 作為模板

📄 許可證

本項目採用 MIT 許可證。