Skip to main content
Glama
syucream

Lightdash MCP Server

by syucream

lightdash_get_charts_as_code

Retrieve chart definitions as machine-readable code from a Lightdash project by providing its UUID.

Instructions

Get charts 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

  • Case handler for 'lightdash_get_charts_as_code' tool. Parses arguments with GetChartsAsCodeRequestSchema, calls Lightdash API GET /api/v1/projects/{projectUuid}/charts/code, and returns the results as JSON text.
    case 'lightdash_get_charts_as_code': {
      const args = GetChartsAsCodeRequestSchema.parse(
        request.params.arguments
      );
      const { data, error } = await lightdashClient.GET(
        '/api/v1/projects/{projectUuid}/charts/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 GetChartsAsCodeRequestSchema, validating a projectUuid string (UUID format).
    export const GetChartsAsCodeRequestSchema = z.object({
      projectUuid: z
        .string()
        .uuid()
        .describe(
          'The UUID of the project. You can obtain it from the project list.'
        ),
    });
  • src/mcp.ts:89-93 (registration)
    Tool registration entry for 'lightdash_get_charts_as_code' with description and inputSchema.
    {
      name: 'lightdash_get_charts_as_code',
      description: 'Get charts as code for a project',
      inputSchema: zodToJsonSchema(GetChartsAsCodeRequestSchema),
    },
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, and the description does not disclose behavioral traits such as whether it is read-only, what format 'as code' entails, or any side effects. The agent lacks critical context to understand the tool's behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is very concise at 6 words, but it is appropriately front-loaded and has no wasted words. A slightly longer description could improve clarity without losing conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of output schema and the presence of sibling tools, the description is incomplete. It does not explain what 'as code' means or how the output differs from listing charts, leaving the agent underinformed for proper invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and explains the single parameter clearly. The description adds no additional meaning beyond the schema, so it meets the baseline for parameter semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the verb 'Get', the resource 'charts as code', and scope 'for a project', making the purpose clear. However, it does not differentiate from siblings like lightdash_list_charts or lightdash_get_dashboards_as_code, which might cause confusion.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance provided on when to use this tool versus alternatives like lightdash_list_charts or lightdash_get_dashboards_as_code. No prerequisites or context for proper usage are given.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

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