list_native_sheets

Discover native (Bridge-Town-authored) input sheets and output sheet views attached to a model. Returns cheap cached summary counts only (row_count, tab_count, calculation_status) — no cell data, no Git read. Use get_native_sheet to read a specific sheet’s tabs and cells. Optionally filter by purpose (‘input’ | ‘output’).

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model whose native sheets to list.')]	Yes	—
purpose	Annotated[Literal['', 'input', 'output'], Field(description="Optional purpose filter: 'input' or 'output'. Omit or pass an empty string for no filter.")]	No	''

Returns

Returns a structured object. Top-level fields:

• model_name (string)
• sheets (array<object>)
• total_count (integer)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "list_native_sheets",
  "arguments": {
    "model_name": "forecasts"
  }
}

Response

{
  "model_name": "forecasts",
  "sheets": [
    {
      "sheet_id": "assumptions",
      "name": "Assumptions",
      "purpose": "input",
      "attached_model": "model/revenue.py",
      "branch": "main",
      "latest_commit_sha": "abc1234def5678901234567890abcdef12345678",
      "row_count": 42,
      "tab_count": 2,
      "calculation_status": "clean",
      "updated_at": "2026-04-28T10:00:00+00:00"
    },
    {
      "sheet_id": "q1-output",
      "name": "Q1 Output View",
      "purpose": "output",
      "attached_model": null,
      "branch": "main",
      "latest_commit_sha": "abc1234def5678901234567890abcdef12345678",
      "row_count": 120,
      "tab_count": 1,
      "calculation_status": "dirty",
      "updated_at": "2026-04-28T10:00:00+00:00"
    }
  ],
  "total_count": 2
}

Notes

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