publish_repo_dashboard

Validate or publish a standalone HTML dashboard as a new immutable, versioned dashboard-package revision. Provide exactly one source: path for an HTML entrypoint already committed to the model repo, or html plus model_run_id for bounded inline HTML produced from an authorized successful run. Inline HTML removes the need to commit a one-off visualization before publishing it.

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	None, Field(description=‘Repo path to the committed HTML entrypoint. Provide exactly one of path or html.’)]`	No	`None`
`html`	`Annotated[str	None, Field(description=‘Inline standalone HTML tied to model_run_id. Provide exactly one of html or path; inline HTML runs through the same package validation as repo HTML.’)]`	No	`None`
`model_run_id`	`Annotated[str	None, Field(description=‘UUID of the authorized successful model run that produced inline html. Required with html and unavailable with path.’)]`	No	`None`
`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`

Returns

Returns a structured object. Top-level fields:

dashboard_id (string)
dashboard_name (string)
model (string)
model_run_id (string)
created (boolean)
source_kind (string)
source_branch (string)
source_commit_sha (string)
revision_number (integer)
content_hash (string)
dry_run (boolean)
validation_status (string)
validation_findings (array)
published_at (null)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "publish_repo_dashboard",
  "arguments": {
    "model_name": "forecasts",
    "dashboard_name": "Run Waterfall",
    "html": "<html><body><h1>Run Waterfall</h1></body></html>",
    "model_run_id": "66666666-6666-6666-6666-666666666666",
    "dry_run": true
  }
}

Response

{
  "dashboard_id": "77777777-7777-7777-7777-777777777777",
  "dashboard_name": "Run Waterfall",
  "model": "forecasts",
  "model_run_id": "66666666-6666-6666-6666-666666666666",
  "created": true,
  "source_kind": "inline_html",
  "source_branch": "scenario/aggressive-growth",
  "source_commit_sha": "abc1234def5678901234567890abcdef12345678",
  "revision_number": 1,
  "content_hash": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
  "dry_run": true,
  "validation_status": "passed",
  "validation_findings": [],
  "published_at": null
}

Notes

Module: Dashboards
Requires an authenticated Bridge Town session (OAuth) or an API token.