get_google_spreadsheet_metadata

Get a connected Google Sheet’s title, tabs, and dimensions; optionally include the available formatting presets. Provides view: gsheet-planner (ui://apps/gsheet-planner) renders this tool’s result when MCP Apps are available.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model.')]	Yes	—
spreadsheet_id	`Annotated[str	None, Field(description=‘Google Spreadsheet ID from the sheet URL.’)]`	No	None
source_name	`Annotated[str	None, Field(description=‘Logical name of the connected Google Sheet data source.’)]`	No	None
include_format_presets	Annotated[bool, Field(description='When true, include the finance-oriented Google Sheets formatting presets (a reference vocabulary for describing a manual formatting style; Bridge Town has no tool that applies formatting itself) without an extra call.')]	No	False
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

• spreadsheet_id (string)
• title (string)
• sheets (array<object>)
• format_presets (array<object>)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "get_google_spreadsheet_metadata",
  "arguments": {
    "model_name": "forecasts",
    "spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
    "include_format_presets": true
  }
}

Response

{
  "spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
  "title": "FY26 Forecast",
  "sheets": [
    {
      "sheetId": 0,
      "title": "Forecast",
      "index": 0
    }
  ],
  "format_presets": [
    {
      "name": "financial_table",
      "description": "Financial table styling."
    },
    {
      "name": "kpi_dashboard",
      "description": "Key-value dashboard styling."
    }
  ]
}

Notes

• Module: Google Sheets
• Requires an authenticated Bridge Town session (OAuth) or an API token.