---
title: "List Dashboard Widgets"
description: "Discovery + how-to helper for building and customizing dashboards."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.speakai.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List Dashboard Widgets

`list_dashboard_widgets` is a tool in the Speak AI MCP server. Discovery + how-to
helper for building and customizing dashboards.

## What does it do?

Discovery + how-to helper for building and customizing dashboards. Returns every
widget type with what it shows and the exact strict `config` shape it accepts, the
shared vocabulary (metric grammar, groupBy, per-widget binding, filters, thresholds,
sources, date-range presets, sections), design rules for composing a dashboard that
reads well, two complete worked example payloads, and tips for managing dashboards.
Call this before `create_dashboard` / `update_dashboard`.

## Parameters

`list_dashboard_widgets` takes no parameters.

## Behaviour

The Speak AI MCP server publishes these behaviour hints for
`list_dashboard_widgets`.

- Only reads data. Does not modify your workspace.
- Does not delete or overwrite existing data.
- Repeating an identical call is safe.
- Stays inside Speak AI. Does not reach other systems.

## Related

- [Dashboards](/mcp/tools/dashboards/) lists the rest of the Dashboards category.
- [Tool reference](/mcp/tools/) lists every Speak AI MCP server tool.
- [MCP server](/mcp/) covers setup, supported clients, and what agents can do once
  connected.

Source: https://docs.speakai.co/mcp/tools/dashboards/list_dashboard_widgets/index.mdx