describe_model

Use describe_model for static model metadata without executing code. Follow with run only after the contract and required inputs are understood.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model.')]	Yes	—
path	Annotated[str, Field(description="Model-relative path of a Python model file to statically describe (e.g. 'model/revenue.py'). Omit to get a bounded model-level overview instead of a single-file contract.")]	No	''
include	`Annotated[list[Literal[‘branches’, ‘runs’, ‘data_sources’]]	None, Field(description=“Overview mode only (path omitted). Which bounded sections to add beyond files: ‘branches’ (recent branches), ‘runs’ (recent run summaries), ‘data_sources’ (attached data sources). Defaults to [‘branches’] — the model-inventory view (formerly get_model_overview). Pass [‘runs’, ‘data_sources’] for the model-review-context view used before proposing a logic change (formerly get_model_review_context).”)]`	No	None
branch	`Annotated[str	None, Field(description=“Branch to read from. Single-file mode: read path from this branch. Overview mode: scope files/runs to this branch. Defaults to the model’s default branch when omitted or null.”)]`	No	None
max_files	Annotated[int, Field(description='Overview mode only. Maximum file entries; capped at 50.')]	No	25
max_branches	Annotated[int, Field(description='Overview mode only. Maximum branch entries; capped at 50.')]	No	20
max_runs	Annotated[int, Field(description='Overview mode only. Maximum run summaries; capped at 20.')]	No	5
max_data_sources	Annotated[int, Field(description='Overview mode only. Maximum data-source entries; capped at 20.')]	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)
• path (string)
• sha (string)
• inputs (array<string>)
• outputs (array<string>)
• dependencies (null)
• warnings (array)
• confidence (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "describe_model",
  "arguments": {
    "model_name": "forecasts",
    "path": "model/revenue.py"
  }
}

Response

{
  "model": "forecasts",
  "path": "model/revenue.py",
  "sha": "abc1234def5678901234567890abcdef12345678",
  "inputs": [
    "growth_rate"
  ],
  "outputs": [
    "revenue"
  ],
  "dependencies": null,
  "warnings": [],
  "confidence": "high"
}

Notes

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