edit_dashboard_widget

Edit an existing widget in a dashboard.

Edit an existing widget in a dashboard.

Destructive · Writes data · Idempotent · Calls external systems. This tool can modify or delete data. Review the arguments before letting an agent call it.

Parameters

FieldTypeRequiredDescription
acknowledgebooleanNoSet to true after user approves continuing past the edit limit.
dashboard_uidstringYesDashboard UID
hnumberNoNew grid height (optional)
wnumberNoNew grid width (optional)
widget_idstringYesWidget ID within the dashboard (the 'i' field from get_dashboard layout)
widget_jsonstringYesJSON string of the new widget data section
xnumberNoNew grid x position (optional — preserves current if omitted)
ynumberNoNew grid y position (optional)

Example arguments

Illustrative arguments an agent supplies when calling this tool:

{
  "dashboard_uid": "string",
  "widget_id": "string",
  "widget_json": "string"
}

Description

Replaces the widget data section. Position (x/y/w/h) is preserved unless explicitly provided.

Prerequisite: Use query_metrics with SHOW MEASUREMENTS and SHOW FIELD KEYS if changing query fields.

Workflow: get_dashboard → edit_dashboard_widget → get_dashboard (verify).

What's next?

All MCP tools

Browse the full tool reference by category.

Connect a client

Point Claude, Cursor, or Claude Code at the server.

Last updated on