lightdash_list_dashboards
Retrieve all dashboards within a Lightdash project by providing the project UUID to view available analytics dashboards.
Instructions
List all dashboards in a project
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectUuid | Yes | The UUID of the project. You can obtain it from the project list. |
Implementation Reference
- src/mcp.ts:232-261 (handler)Handler that calls Lightdash API to list dashboards in the specified project and returns JSON results.case 'lightdash_list_dashboards': { const args = ListDashboardsRequestSchema.parse( request.params.arguments ); const { data, error } = await lightdashClient.GET( '/api/v1/projects/{projectUuid}/dashboards', { params: { path: { projectUuid: args.projectUuid, }, }, } ); if (error) { throw new Error( `Lightdash API error: ${error.error.name}, ${ error.error.message ?? 'no message' }` ); } return { content: [ { type: 'text', text: JSON.stringify(data.results, null, 2), }, ], }; }
- src/schemas.ts:32-39 (schema)Zod schema defining the input for the tool: requires projectUuid.export const ListDashboardsRequestSchema = z.object({ projectUuid: z .string() .uuid() .describe( 'The UUID of the project. You can obtain it from the project list.' ), });
- src/mcp.ts:69-73 (registration)Tool registration in the listTools response, including name, description, and input schema.{ name: 'lightdash_list_dashboards', description: 'List all dashboards in a project', inputSchema: zodToJsonSchema(ListDashboardsRequestSchema), },