Skip to content

Commit 4b65823

Browse files
committed
docs: update README
1 parent 132636a commit 4b65823

2 files changed

Lines changed: 28 additions & 13 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<a href="https://github.com/PaperDebugger/PaperDebugger?tab=AGPL-3.0-1-ov-file"><img src="https://img.shields.io/github/license/PaperDebugger/paperdebugger" alt="License"/></a>
1111
</div>
1212

13-
**PaperDebugger** is an AI-powered academic writing assistant that helps researchers debug and improve their research papers with intelligent suggestions and seamless Overleaf integration, without leaving the editor. It is powered by a custom MCP-based orchestration engine that simulates the full academic workflow **Research → Critique → Revision**. <br>
13+
**PaperDebugger** is an AI-powered academic writing assistant that helps researchers debug and improve their research papers with intelligent suggestions and seamless Overleaf integration, without leaving the editor. It is powered by our [custom MCP-based orchestration engine](demo/xtramcp/readme.md) that simulates the full academic workflow **Research → Critique → Revision**. <br>
1414
This enables multi-step reasoning, reviewer-style critique, and structured revision passes beyond standard chat-based assistance.
1515

1616
<div align="center">
@@ -51,7 +51,7 @@ PaperDebugger never modifies your project, it only reads and provides suggestion
5151
- **💬 Comment System**: Automatically generate and insert comments into your project
5252
- **📚 Prompt Library**: Custom prompt templates for different use cases
5353
- **🔒 Privacy First**: Your content stays secure - we only read, never modify
54-
- **🧠 Multi-Agent Orchestration**[XtraMCP](https://github.com/PaperDebugger/xtramcp) support for literature-grounded research, AI-Conference review, citation verification, and domain-specific revision
54+
- **🧠 Multi-Agent Orchestration**[XtraMCP](demo/xtramcp/readme.md) support for literature-grounded research, AI-Conference review, citation verification, and domain-specific revision
5555

5656
https://github.com/user-attachments/assets/6c20924d-1eb6-44d5-95b0-207bd08b718b
5757

demo/xtramcp/readme.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ This document describes the core tools exposed by XtraMCP and how they combine i
1919
| Tool Name | Role | Purpose | Primary Data Source | Presently Deployed |
2020
|---------------------------|-----------|-----------------------------------------------------------------|--------------------------------|----------------------|
2121
| `search_relevant_papers` | Researcher | Fast semantic search over recent CS papers in a local vector DB, enhanced with semantic re-ranker module | Local DB | Yes |
22-
| `deep_research` | Researcher | Multi-step literature synthesis & positioning of your draft | Local DB + retrieved papers analysis | *Temporarily Disabled* |
23-
| `online_search_papers` | Researcher | Online search over external academic corpora | OpenReview + arXiv | Yes (*Partially*) with arXiv |
24-
| `review_paper` | Reviewer | Conference-style structured review of a draft | Your draft + section-level review (static & semantic) | Yes (*Partially*) — Title, Abstract, Intro — to balance operational cost. |
25-
| `verify_citations` | Reviewer | Ensure citations are grounded, valid, and traceable | Your draft's bibliography | *Coming Soon*! |
22+
| `deep_research` | Researcher | Multi-step literature synthesis & positioning of your draft | Local DB + retrieved papers analysis | Yes |
23+
| `online_search_papers` | Researcher | Online search over external academic corpora | OpenReview + arXiv | Yes |
24+
| `review_paper` | Reviewer | Conference-style structured review of a draft | Your draft + section-level review (static & semantic) | Yes (slightly scaled down to balance operational cost) |
25+
| `verify_citations` | Reviewer | Ensure citations are grounded, valid, and traceable | Your draft's bibliography | Yes |
26+
| `generate_citations` | Reviewer | Generates BibTeX-style citations by simplying providing arxiv ID / DOI / URL / title | Your draft | Yes |
2627
| `enhance_academic_writing`| Enhancer | Context-aware rewriting and polishing of selected text | Your draft + XtraGPT | *Temporarily Disabled* |
27-
| `get_user_papers` | Misc / Researcher| Fetch all published papers with description, by a specific user | OpenReview | *Disabled* (requires auth; easy to enable with local deployment) |
28-
| `search_user` | Misc | Fetch user's profile, including info such as publications, co-authors | OpenReview | *Disabled* (requires auth; easy to enable with local deployment)|
28+
| `get_user_papers` | Misc / Researcher| Fetch all published papers with description, by a specific user | OpenReview | Yes |
29+
| `search_user` | Misc | Fetch user's profile, including info such as publications, co-authors | OpenReview | Yes |
2930

3031
---
3132

@@ -122,7 +123,7 @@ Analyze and review a draft against the standards of **top-tier ML conferences**
122123
## 5. `verify_citations`
123124

124125
**Purpose:**
125-
Verify that citations in your draft are valid, grounded, and traceable, helping reduce the risk of desk rejection due to incorrect or unverifiable references.
126+
Verify that citations in your draft are valid, grounded, and traceable, helping reduce the risk of desk rejection due to incorrect or unverifiable references. There have been [embarrassing cases](https://gptzero.me/news/neurips/) where accepted papers were found with hallucinated citations. This tool helps to avoid such occurrences.
126127

127128
**How it works**:
128129
- Parses your bibliography and in-text citations.
@@ -137,8 +138,21 @@ Typical usage:
137138
- “Check whether any citations in this draft are invalid or unverifiable.”
138139

139140
---
141+
## 6. `generate_citations`
140142

141-
## 6. `enhance_academic_writing`
143+
**Purpose:**
144+
Generate BibTeX-style citations easily by simply providing the paper's arxiv ID or DOI or URL or just its title.
145+
146+
**How it works**:
147+
- Searches online for the paper's official source
148+
- Formats into BibTeX-style citation ready for copy-pasting
149+
- Inform user if proposed information is invalid / unmatched
150+
151+
Typical usage:
152+
- “generate_citations: [https://arxiv.org/abs/2505.11336, ... ]
153+
154+
---
155+
## 7. `enhance_academic_writing`
142156

143157
**Purpose:**
144158
Suggest **context-aware academic writing enhancements** for selected text.
@@ -157,7 +171,7 @@ Suggest **context-aware academic writing enhancements** for selected text.
157171
- "enhance_academic_writing this paragraph to be clearer and more concise, preserving all technical details.”
158172
- "enhance_academic_writing the abstract to be suitable for NeurIPS.”
159173

160-
## 7. `get_user_papers`
174+
## 8. `get_user_papers`
161175

162176
**Purpose:**
163177
Retrieve **all papers authored by a given user** (OpenReview), identified by email.
@@ -172,7 +186,7 @@ Useful for quickly assembling a researcher’s publication list or grounding con
172186
- “get_user_papers for <author-email> in summary mode.”
173187
- “Retrieve all publications by this researcher and then compare my draft using deep_research.”
174188

175-
## 8. Conference Formatter (WIP)
189+
## 9. Conference Formatter (WIP)
176190

177191
Upcoming workflows will:
178192

@@ -191,7 +205,8 @@ Upcoming workflows will:
191205

192206
- **Reviewer Flow**
193207
1. Run `review_paper` on the full draft.
194-
2. For high-impact issues, call `enhance_academic_writing` on the relevant spans.
208+
2. For high-impact issues, call `enhance_academic_writing` on the relevant spans.
209+
3. Verify your citations with `verify_citations` or if you haven't yet formatted them, include with `generate_citations`.
195210

196211
- **Enhancer Flow**
197212
1. Select a paragraph or section in Overleaf.

0 commit comments

Comments
 (0)