Skip to main content
Glama
syucream

Lightdash MCP Server

by syucream

lightdash_get_dashboards_as_code

Export Lightdash dashboards as code files to enable version control, automate deployments, and maintain consistency across environments.

Instructions

Get dashboards as code for a project

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectUuidYesThe UUID of the project. You can obtain it from the project list.

Implementation Reference

  • The switch case that handles execution of the 'lightdash_get_dashboards_as_code' tool by parsing arguments, calling the Lightdash API endpoint '/api/v1/projects/{projectUuid}/dashboards/code', and returning the results as JSON.
    case 'lightdash_get_dashboards_as_code': {
      const args = GetDashboardsAsCodeRequestSchema.parse(
        request.params.arguments
      );
      const { data, error } = await lightdashClient.GET(
        '/api/v1/projects/{projectUuid}/dashboards/code',
        {
          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 for input validation of the tool, requiring a projectUuid.
    export const GetDashboardsAsCodeRequestSchema = z.object({
      projectUuid: z
        .string()
        .uuid()
        .describe(
          'The UUID of the project. You can obtain it from the project list.'
        ),
    });
  • src/mcp.ts:94-98 (registration)
    Tool registration in the listTools response, specifying name, description, and input schema.
    {
      name: 'lightdash_get_dashboards_as_code',
      description: 'Get dashboards as code for a project',
      inputSchema: zodToJsonSchema(GetDashboardsAsCodeRequestSchema),
    },

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