Get Comments
get_commentsList comments on a runbook, optionally filtered to a specific task, to read progress notes and status updates recorded during execution.
Instructions
List the comments on a runbook, optionally filtered to a specific task.
Comments are the append-only, timestamped log channel while a runbook is running (task descriptions are locked outside edit/dynamic mode), so this is how to read back progress notes or status that were recorded earlier with add_comment, by a person or by an agent.
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": {
"runbook_id": "<runbook_id>"
},
"name": "get_comments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | No | Optional ID of a task (the same task ID used by the other task tools) to return only the comments attached to that task. When omitted, every comment on the runbook is returned, including runbook-level ones. | |
| runbook_id | Yes | The ID of the runbook to read comments from. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| meta | Yes | Top-level metadata for a list response. | |
| links | Yes | Pagination links for a list response. | |
| included | No |