list_comments
Retrieve review comment threads and their document positions from an Overleaf project, filtered by status, author, or file, to inspect open feedback before editing.
Instructions
List review comment threads and lazily resolve their document positions. Defaults to open threads. author keeps threads with a message whose author display name contains it (case-insensitive) or whose author id equals it. Returns threads, each with id, status, messages (id, author { id, displayName } or null, content, ISO timestamp), resolvedAt and resolvedBy when resolved, and when located filePath, start, end (1-based line, UTF-16 column), and quotedText; a thread without a document range has unlocated: true. Without filePath, positionsUnavailable: true means the deployment has no project-wide range index and every thread is unlocated.
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_comments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| author | No | Author display name substring, or exact author id | |
| status | No | open | |
| filePath | No | Only threads anchored in this document | |
| projectId | Yes | Overleaf project ID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| threads | Yes | ||
| positionsUnavailable | Yes |