list_tracked_changes
Lists tracked changes (inserts and deletes) with their locations, authors, and revisions so they can be reviewed and then accepted or rejected. Filter by document, type, or author.
Instructions
List tracked changes (suggestions) and where they are, so they can be accepted or rejected with manage_tracked_changes. With filePath, that document is read and its list is authoritative. Without it, Overleaf's project range index only chooses which documents to read: just the documents it lists with changes are read, its change ids are never used, and it may lag or leave a document out, so name a document with filePath for an authoritative list (this matters most for history-OT documents, whose index ids are never valid). indexUnavailable: true means the deployment has no index and no document was read. type and authorId keep only matching changes; limit (default 100, at most 500) caps the changes returned across all documents, totalMatched counts every match, and truncated says some were left out. Returns documents, each with filePath, revision (pass it to manage_tracked_changes), protocol, totalChanges (every tracked change in the document, unfiltered), undecidableChanges when some changes carry no id and cannot be decided by this server, and changes: changeId, type (insert: suggested text that is visible; delete: suggested removal of text that is no longer visible), start and end (1-based line and UTF-16 column in the text read_file returns; a delete is a point, so its start equals its end), length in UTF-16 units, excerpt of the inserted or deleted text (at most excerptChars UTF-16 units, default 120, 0 for none) with excerptTruncated, authorId (an Overleaf user id, or null), an ISO timestamp, and pairedChangeId linking the insert and the delete of one replacement. Also returns trackChangesActive. Ids merge and split as the document is edited, and history-OT ids are valid only with the revision they were listed with, so list again before deciding.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"projectId": "<projectId>"
},
"name": "list_tracked_changes"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Only inserts or only deletes | |
| limit | No | Most changes returned across all documents | |
| authorId | No | Only changes by this Overleaf user id | |
| filePath | No | Only this document, read directly rather than through the index | |
| projectId | Yes | Overleaf project ID | |
| excerptChars | No | Longest excerpt of each change, in UTF-16 units; 0 for none |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documents | Yes | ||
| truncated | Yes | ||
| totalMatched | Yes | ||
| indexUnavailable | No | ||
| trackChangesActive | Yes |