build_dashboard
Create a dashboard with all widgets in a single atomic call.
Create a dashboard with all widgets in a single atomic call.
Writes data · Calls external systems.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
bucket | string | No | InfluxDB bucket for passive agent data (optional) |
name | string | Yes | Dashboard name |
operator | string | Yes | Operator slug |
preview | boolean | No | Dry-run mode: validate, normalize, and auto-position all widgets without creating the dashboard. Returns ASCII grid + normalized data + warnings. |
widgets | string | Yes | JSON array of widget objects (same format as widget_json in add_dashboard_widget, without _metadata). Optional _w/_h per widget to override default size. |
Example arguments
Illustrative arguments an agent supplies when calling this tool:
{
"operator": "string",
"name": "string",
"widgets": "string"
}
Description
Validates all widgets upfront — if ANY fails, NONE are created. Auto-positions widgets using type defaults (override with _w/_h per widget). Returns ASCII grid preview + all widget IDs.
PREREQUISITE: call platform_guide topic=dashboards for widget types, grid layout rules, and the full creation workflow. Use query_metrics with SHOW MEASUREMENTS and SHOW FIELD KEYS to discover the InfluxDB schema before building widget queries.
Each widget object uses the same format as widget_json in add_dashboard_widget (without _metadata). Optional _w/_h fields override type default dimensions. Position (_x/_y) is always auto-calculated — do not provide.
Atomic: if ANY widget fails validation, NONE are created. Fix all errors and re-submit.
Related
What's next?
Last updated on