run_report
Generate a Gramps report by report ID, returning the output file or a background task ID to poll; living people and private records are excluded unless requested.
Instructions
Generate a report and return the file it produced.
Living people and private records are left out (living_people 0, incl_private false) unless you pass those options or include_private; Gramps' own default includes both.
Usually runs in the background, returning a task_id to poll with get_job.
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": {
"report_id": "<report_id>"
},
"name": "run_report"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| locale | No | Language code for the report output. | |
| options | No | Overrides for the report's defaults, merged over them. Common keys: 'pid' (the central person's gramps_id), 'maxgen', 'off' (output format), 'living_people'. | |
| report_id | Yes | Report id, from list_reports. | |
| include_private | No | Show living people and private records in full. Only when the user asks for them; they are withheld by default. |