Skip to main content
Glama
syucream

Lightdash MCP Server

by syucream

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
NameRequiredDescriptionDefault
projectUuidYesThe UUID of the project. You can obtain it from the project list.

Implementation Reference

  • 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),
          },
        ],
      };
    }
  • 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),
    },

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/syucream/lightdash-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server