get_native_sheet

Read one native sheet’s full content: tabs, cells, formulas, formatting, calculation status, and provenance. Reads the sheet document from the model repository at the commit recorded in the native sheets cache; use list_native_sheets first to find a sheet_id. Pass tab_id to return only one tab and bound the response size for large sheets.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model that owns the sheet.')]	Yes	—
sheet_id	Annotated[str, Field(description='Sheet identifier, as returned by list_native_sheets.')]	Yes	—
tab_id	Annotated[str, Field(description="Optional tab_id to return only that tab's cells and bound the response size. Omit or pass an empty string to return all tabs.")]	No	''

Returns

Returns a structured object. Top-level fields:

• model_name (string)
• sheet_id (string)
• name (string)
• purpose (string)
• attached_model (string)
• branch (string)
• latest_commit_sha (string)
• row_count (integer)
• tab_count (integer)
• calculation_status (string)
• tabs (array<object>)
• calculation (object)
• provenance (object)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "get_native_sheet",
  "arguments": {
    "model_name": "forecasts",
    "sheet_id": "assumptions"
  }
}

Response

{
  "model_name": "forecasts",
  "sheet_id": "assumptions",
  "name": "Assumptions",
  "purpose": "input",
  "attached_model": "model/revenue.py",
  "branch": "main",
  "latest_commit_sha": "abc1234def5678901234567890abcdef12345678",
  "row_count": 2,
  "tab_count": 1,
  "calculation_status": "clean",
  "tabs": [
    {
      "tab_id": "tab1",
      "name": "Sheet1",
      "row_count": 2,
      "column_count": 2,
      "cell_encoding": "sparse",
      "cells": {
        "A1": {
          "value": "Growth Rate",
          "formula": null,
          "format": null,
          "style": null,
          "number_format": null
        },
        "B1": {
          "value": 0.12,
          "formula": null,
          "format": null,
          "style": null,
          "number_format": "percent"
        }
      },
      "rows": [],
      "formatting": {
        "column_widths": {},
        "row_heights": {},
        "frozen_rows": 0,
        "frozen_columns": 0,
        "show_gridlines": true
      }
    }
  ],
  "calculation": {
    "engine_version": "v1",
    "status": "clean",
    "last_evaluated_at": "2026-04-28T10:00:00+00:00"
  },
  "provenance": {
    "source": "user",
    "run_id": null,
    "commit_sha": "abc1234def5678901234567890abcdef12345678"
  }
}

Notes

• Module: Native Sheets
• Requires authentication via API token or Auth0 JWT.