Skip to main content
Glama
syucream

Lightdash MCP Server

by syucream

lightdash_get_project

Retrieve detailed information about a specific Lightdash project by providing its UUID.

Instructions

Get details of a specific project

Input Schema

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

Implementation Reference

  • src/mcp.ts:54-58 (registration)
    Tool registration with name, description, and inputSchema for the 'lightdash_get_project' tool in the ListTools handler
    {
      name: 'lightdash_get_project',
      description: 'Get details of a specific project',
      inputSchema: zodToJsonSchema(GetProjectRequestSchema),
    },
  • Handler implementation within the CallToolRequest handler. Parses arguments via GetProjectRequestSchema, calls GET /api/v1/projects/{projectUuid} on the Lightdash API, and returns results as JSON text.
    case 'lightdash_get_project': {
      const args = GetProjectRequestSchema.parse(request.params.arguments);
      const { data, error } = await lightdashClient.GET(
        '/api/v1/projects/{projectUuid}',
        {
          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 lightdash_get_project: a required projectUuid string (UUID format) describing that it can be obtained from the project list.
    export const GetProjectRequestSchema = z.object({
      projectUuid: z
        .string()
        .uuid()
        .describe(
          'The UUID of the project. You can obtain it from the project list.'
        ),
    });
Behavior2/5

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

No annotations are provided, and the description lacks behavioral details such as read-only nature, error handling (e.g., project not found), authentication needs, or rate limits. This is a significant gap for a tool that likely involves a read operation.

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

Conciseness5/5

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

The description is a single, clear sentence with no wasted words. It is appropriately front-loaded and concise.

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

Completeness3/5

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

Given the tool's simplicity (one required parameter, no output schema), the description is adequate but could be improved by mentioning the return type or that it provides full project details. The lack of annotations increases the burden on the description, which it does not fully meet.

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 coverage is 100%, and the parameter description in the schema ('The UUID of the project. You can obtain it from the project list.') is adequate. The tool description adds no additional meaning beyond what the schema already provides, meeting the baseline.

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

Purpose5/5

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

The description 'Get details of a specific project' clearly states the action (get) and resource (project), and implicitly differentiates from sibling tools like lightdash_list_projects which lists projects.

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

Usage Guidelines3/5

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

The description implies use when you have a project UUID, but does not explicitly state when to use this tool versus alternatives (e.g., list_projects to obtain the UUID). No exclusions or prerequisites are mentioned.

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