List Comments
list_commentsRetrieve paginated document comments with nested replies and resolution state, so you can collect existing comment IDs before updating, deleting, or resolving them.
Instructions
List paginated comments for a document, including nested replies and resolution state. Use this before update_comment, delete_comment, or resolve_comment when you need the existing comment ids.
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": {
"docId": "<docId>"
},
"name": "list_comments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | Cursor from pageInfo.endCursor for fetching the next page. | |
| docId | Yes | Document id whose comments should be listed. | |
| first | No | Maximum number of comments to return from the AFFiNE pagination connection (1-200). | |
| offset | No | Zero-based offset used by AFFiNE pagination (maximum 1,000,000). Do not combine with after unless the AFFiNE API requires it. | |
| workspaceId | No | AFFiNE workspace id. Omit only when AFFINE_WORKSPACE_ID is configured. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | ||
| code | No | ||
| edges | No | ||
| error | No | ||
| details | No | ||
| pageInfo | No | ||
| causeCode | No | ||
| retryable | No | ||
| totalCount | No | ||
| recoveryGuidance | No |