config.schema

The Configuration's JSON Schema: every setting, its type, default and description.

Returns the Configuration's JSON Schema: every setting with its type, default and description. Use it to find the path and the allowed values before calling config.set. It works with no book open.

Examples

Example: with no book.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"config.schema","params":{}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": "red-ale Configuration",
    "type": "object",
    "properties": {
      "accountingPeriod": {
        "type": "object",
        "…": "…"
      },
      "…": "…"
    },
    "…": "…"
  }
}

Command line

red-ale exec config.schema

It prints:

{
  "title": "red-ale Configuration",
  "type": "object",
  "properties": {
    "accountingPeriod": {
      "type": "object",
      "…": "…"
    },
    "…": "…"
  },
  "…": "…"
}

MCP tool call

Tool call:

{"name":"config.schema","arguments":{}}

Result:

{
  "structuredContent": {
    "title": "red-ale Configuration",
    "type": "object",
    "properties": {
      "accountingPeriod": {
        "type": "object",
        "…": "…"
      },
      "…": "…"
    },
    "…": "…"
  }
}

Effect: read.

Params

Params for methods that take none.

Type: NoParams.

Result

Type: any.