Skip to content

get_model_review_context

Get bounded files, recent runs, and data-source context for reviewing model logic. This does not submit a pull-request review or change model state.

read-only · idempotent

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
branch`Annotated[strNone, Field(description=‘Optional branch to inspect.’)]`NoNone
max_filesAnnotated[int, Field(description='Maximum file entries; capped at 50.')]No20
max_runsAnnotated[int, Field(description='Maximum run summaries; capped at 20.')]No5
max_data_sourcesAnnotated[int, Field(description='Maximum data-source entries; capped at 20.')]No20
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • model (string)
  • branch (string)
  • files (array<object>)
  • runs (array<object>)
  • data_sources (array<object>)
  • truncated (boolean)

See the response example below for the full payload shape.

{
"name": "get_model_review_context",
"arguments": {
"model_name": "forecasts",
"branch": "scenario/aggressive-growth",
"max_files": 10,
"max_runs": 5,
"max_data_sources": 5
}
}
{
"model": "forecasts",
"branch": "scenario/aggressive-growth",
"files": [
{
"path": "run.py",
"size": 4120
}
],
"runs": [
{
"run_id": "66666666-6666-6666-6666-666666666666",
"status": "success"
}
],
"data_sources": [
{
"source_name": "actuals",
"source_type": "parquet"
}
],
"truncated": false
}
  • Module: Models
  • Requires authentication via API token or Auth0 JWT.