describe_model

Use describe_model for static model metadata without executing code

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model containing the file.')]	Yes	—
path	Annotated[str, Field(description="Model-relative path of the Python model file to describe (e.g. 'model/revenue.py').")]	Yes	—
branch	`Annotated[str	None, Field(description=“Branch to read the model from. Defaults to the model’s default branch.”)]`	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.