publish_repo_dashboard

Validate or publish a repo-authored HTML dashboard package. Reads the committed entrypoint and optional manifest/data files. Use dry_run=true to validate without writes.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model.')]	Yes	—
dashboard_name	Annotated[str, Field(description='Unique name for this dashboard.')]	Yes	—
path	Annotated[str, Field(description='Repo path to the committed HTML entrypoint.')]	Yes	—
branch	`Annotated[str	None, Field(description=‘Branch to read; defaults to the model default.’)]`	No	None
manifest_path	`Annotated[str	None, Field(description=‘Optional repo path to a JSON package manifest.’)]`	No	None
data_paths	`Annotated[list[str]	None, Field(description=‘Optional repo paths for package data snapshots.’)]`	No	None
design_skill_id	`Annotated[str	None, Field(description=‘Optional public or caller-owned design context to snapshot.’)]`	No	None
description	`Annotated[str	None, Field(description=‘Optional description displayed below the dashboard title.’)]`	No	None
publish	Annotated[bool, Field(description='Publish immediately; false saves a draft revision.')]	No	False
dry_run	Annotated[bool, Field(description='Validate without writing; cannot be combined with publish.')]	No	False
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None
ctx	`Context	None`	No	None

Returns

Returns a structured object. Top-level fields:

• dashboard_id (string)
• dashboard_name (string)
• model (string)
• validated (boolean)
• published (boolean)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "publish_repo_dashboard",
  "arguments": {
    "model_name": "forecasts",
    "dashboard_name": "Forecast Review",
    "path": "dashboards/forecast/index.html",
    "branch": "scenario/aggressive-growth",
    "dry_run": true
  }
}

Response

{
  "dashboard_id": "77777777-7777-7777-7777-777777777777",
  "dashboard_name": "Forecast Review",
  "model": "forecasts",
  "validated": true,
  "published": false
}

Notes

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