get_model_overview

Get a bounded model inventory of branches and files. Use the returned paths and branch names for precise follow-up reads.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model.')]	Yes	—
max_files	Annotated[int, Field(description='Maximum file entries; capped at 50.')]	No	25
max_branches	Annotated[int, Field(description='Maximum branch entries; capped at 50.')]	No	20
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

• model (string)
• branches (array<object>)
• files (array<object>)
• truncated (boolean)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "get_model_overview",
  "arguments": {
    "model_name": "forecasts",
    "max_files": 10,
    "max_branches": 10
  }
}

Response

{
  "model": "forecasts",
  "branches": [
    {
      "name": "scenario/aggressive-growth",
      "protected": false
    }
  ],
  "files": [
    {
      "path": "run.py",
      "size": 4120
    }
  ],
  "truncated": false
}

Notes

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