configure_dashboard
Create or update a widget on your agent dashboard. Use this to display key metrics, charts, tables, or timelines that help the user understand your work at a glance. Each call creates or updates one widget.
[write-tier — first use may require a manager's approval; a from-now-on approval makes future calls seamless, a just-once approval re-asks next time.]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Data rows for chart/table/list/gantt widgets. Each item is an object. - chart: [{ label: "Jan", value: 100 }, ...] - table: [{ col1: "val", col2: "val" }, ...] - list: [{ label: "Item", status: "done", detail: "..." }, ...] - gantt: [{ label: "Task", start: "2024-01-01", end: "2024-01-15", status: "active" }, ...] | |
| title | Yes | Display title for the widget (e.g., "Monthly Revenue", "Content Pipeline") | |
| config | No | Widget configuration. Shape depends on widget_type: - metric: { value, previous_value, format ("number"|"currency"|"percent"|"text"), trend_direction ("up"|"down"|"flat"), suffix } - chart: { chart_type ("bar"|"line"|"area"), x_axis, y_axis, color } - table: { columns: [{ key, label, align }], sortable, page_size } - list: { status_field, label_field, detail_field } - gantt: { start_field, end_field, label_field, status_field } - status: { status, status_color ("green"|"amber"|"red"|"blue"|"purple"|"slate"), detail, icon_emoji } - progress: { value (0-100), target_label, current_label, color (CSS class) } - kpi_row: { kpis: [{ label, value, trend ("up"|"down"|"flat"), format }] } - progress_ring: { value (0-100), label, color (CSS color) } - activity_status: (use data array with { name, frequency, status, next_run, last_outcome }) - canvas: { html (agent-authored layout HTML — narrative/self-expression, inert: no scripts/forms/controls, max 64KB), title (optional a11y label) } | |
| position | No | Display order (0 = first, higher = later). Default: 0 | |
| companyId | Yes | FreedomOS company id to act within (you must be a member). Required for company-scoped tools. | |
| widget_id | No | UUID of existing widget to update. Omit to create a new widget. | |
| is_visible | No | Whether the widget is visible on the dashboard. Default: true | |
| widget_type | Yes | Type of widget to create |