report.list

Every report template and saved report configuration, and the user scripts that did not load.

Lists every report template (GnuCash's, red-ale's translations of them, and your own scripts) and every saved report configuration, sorted by name, and the user scripts that failed to load (problems). Use it to find the name or GUID of a report to run. It needs no book. A template's menuPath and menuName are GnuCash's menu fields; exportTypes says whether report.exportCsv works on it.

Examples

Example: with no book.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"report.list","params":{}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "reports": [
      {
        "guid": "3298541c236b494998b236dfad6ad752",
        "name": "Account Summary",
        "kind": "builtin",
        "script": "standard/account-summary.rhai",
        "…": "…"
      },
      "…"
    ],
    "problems": []
  }
}

Command line

red-ale exec report.list

It prints:

{
  "reports": [
    {
      "guid": "3298541c236b494998b236dfad6ad752",
      "name": "Account Summary",
      "kind": "builtin",
      "script": "standard/account-summary.rhai",
      "…": "…"
    },
    "…"
  ],
  "problems": []
}

MCP tool call

Tool call:

{"name":"report.list","arguments":{}}

Result:

{
  "structuredContent": {
    "reports": [
      {
        "guid": "3298541c236b494998b236dfad6ad752",
        "name": "Account Summary",
        "kind": "builtin",
        "script": "standard/account-summary.rhai",
        "…": "…"
      },
      "…"
    ],
    "problems": []
  }
}

Effect: read.

Params

Params for methods that take none.

Type: NoParams.

Result

The result of report.list.

reports (array of ReportInfo, required): Every template and saved configuration, sorted by name (bytewise), then GUID.
problems (array of LoadProblem, required): User scripts that did not load, so one bad file does not hide the others.