docLink.pathHead

The configured folder relative document links start from.

Reads the folder that relative document links start from, as a file:// URI, or null when none is set. A document link on a transaction or business document that is a relative path is opened from this folder. It is kept in red-ale's Configuration, not in the book, so the call works with no book open.

Examples

Example: with no book.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"docLink.pathHead","params":{}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "pathHead": null,
    "configFile": null
  }
}

Command line

red-ale exec docLink.pathHead

It prints:

{
  "pathHead": null,
  "configFile": null
}

MCP tool call

Tool call:

{"name":"docLink.pathHead","arguments":{}}

Result:

{
  "structuredContent": {
    "pathHead": null,
    "configFile": null
  }
}

Effect: read.

Params

Params for methods that take none.

Type: NoParams.

Result

The path head setting.

pathHead (string or null): The path head, a file:// URI ending in /, if configured.
configFile (string or null): The configuration file, if the setting is kept in one; otherwise it lasts as long as the server.