TRUECALC
MCP

read:getNamedRanges

Gets the named ranges.

Parameters

This tool takes no parameters.

Returns

NameTypeRequiredDescription
namedRangesarray of { name: string; sheet: string; range: object }yesEvery named range, in declaration order.

Schema

Request payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Payload",
  "description": "Deliberately empty.",
  "type": "object"
}

Response payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Output",
  "type": "object",
  "properties": {
    "namedRanges": {
      "description": "Every named range, in declaration order.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/NamedRangeInfo"
      }
    }
  },
  "required": [
    "namedRanges"
  ],
  "$defs": {
    "NamedRangeInfo": {
      "description": "One named range's identity and real target.",
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "sheet": {
          "description": "The named range's REAL target sheet, parsed from its own `ref`.",
          "type": "string"
        },
        "range": {
          "description": "The named range's target rectangle.",
          "$ref": "#/$defs/CellRange"
        }
      },
      "required": [
        "name",
        "sheet",
        "range"
      ]
    },
    "CellRange": {
      "description": "An inclusive rectangle. `from`/`to` may be equal, a single cell.",
      "type": "object",
      "properties": {
        "from": {
          "description": "Top-left cell, e.g. `\"A1\"`.",
          "type": "string"
        },
        "to": {
          "description": "Bottom-right cell, e.g. `\"B3\"`.",
          "type": "string"
        }
      },
      "required": [
        "from",
        "to"
      ]
    }
  }
}

On this page