help.topics

Every Page of red-ale's Manual, or those of one kind: Page ID, kind, title and summary.

Lists the Pages of red-ale's Manual: Page ID, kind (method, error, report, concept, guide, gnucash, …), title and summary. Give kind to list one kind. Start here to see what the Manual covers, then read a Page with help.get. It works with no book open.

Examples

Example: with no book.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"help.topics","params":{"kind":"error"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "topics": [
      {
        "id": "error/arithmetic",
        "kind": "error",
        "title": "arithmetic",
        "summary": "…"
      },
      "…"
    ]
  }
}

Command line

red-ale exec help.topics '{"kind":"error"}'

It prints:

{
  "topics": [
    {
      "id": "error/arithmetic",
      "kind": "error",
      "title": "arithmetic",
      "summary": "…"
    },
    "…"
  ]
}

MCP tool call

Tool call:

{"name":"help.topics","arguments":{"kind":"error"}}

Result:

{
  "structuredContent": {
    "topics": [
      {
        "id": "error/arithmetic",
        "kind": "error",
        "title": "arithmetic",
        "summary": "…"
      },
      "…"
    ]
  }
}

Effect: read.

Params

Params of help.topics.

kind (PageKind or null): Only Pages of this kind; every Page by default.

Result

Result of help.topics.

topics (array of HelpTopic, required): The Pages, by Page ID.