Dashboards tools

search_dashboards: List the dashboards visible in a project, or fetch one by ID.

search_dashboards

Searches the dashboards visible in a project, or fetches one by ID. Dashboards aggregate multiple analyses into a single page view. Omit dashboard_id to list all dashboards — the response gives you the name, shared flag, home flag, archived flag, and metadata. Pass dashboard_id to fetch the full definition of a single dashboard, including every component configuration (embedded analyses, HTML blocks, images, and so on) in display order.

The list is user-scoped — what's returned reflects what the authenticated user has access to. Component layouts are only included in the detail response.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.
`dashboard_id`	`str`	No	The dashboard ID. Omit to list all dashboards; provide to fetch one.

Response parameters

The tool returns a DashboardsResponse when dashboard_id is omitted, or a DashboardResponse when it's provided.

When dashboard_id is omitted, the DashboardsResponse object has the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[DashboardSummary]`	The dashboard summaries.
`error`	`str \| null`	Error message if the request failed.

The DashboardSummary object has the following fields:

Field	Type	Description
`id`	`str`	The dashboard's unique ID.
`name`	`str`	The dashboard's display name.
`archived`	`bool`	Whether the dashboard has been archived.
`shared`	`bool`	Whether the dashboard is shared with other users.
`home`	`bool`	Whether the dashboard is set as the project home page.
`created`	`any \| null`	Unix timestamp of when the dashboard was created.
`created_by_display_name`	`str \| null`	Display name of the creator.
`edited`	`any \| null`	Unix timestamp of the last edit.
`edited_by_display_name`	`str \| null`	Display name of the last editor.

When dashboard_id is provided, the DashboardResponse object has the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`Dashboard \| null`	The full dashboard definition with all components.
`error`	`str \| null`	Error message if the request failed.

The Dashboard object adds the following field on top of the summary record:

Field	Type	Description
`components`	`list[any]`	The dashboard component definitions (analyses, HTML, images, and so on) in display order. Each component has a `type`, a `config`, and a layout.