lightdash_list_spaces
Retrieve all spaces within a Lightdash project by providing the project UUID to organize and access analytics data structures.
Instructions
List all spaces 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:176-203 (handler)Handler for the lightdash_list_spaces tool: parses arguments, calls Lightdash API to list spaces in the specified project, handles errors, and returns JSON-formatted results.case 'lightdash_list_spaces': { const args = ListSpacesRequestSchema.parse(request.params.arguments); const { data, error } = await lightdashClient.GET( '/api/v1/projects/{projectUuid}/spaces', { 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:14-21 (schema)Zod schema defining the input for lightdash_list_spaces: requires a projectUuid (UUID string).export const ListSpacesRequestSchema = z.object({ projectUuid: z .string() .uuid() .describe( 'The UUID of the project. You can obtain it from the project list.' ), });
- src/mcp.ts:59-63 (registration)Registration of the lightdash_list_spaces tool in the MCP server's listTools response, including name, description, and input schema.{ name: 'lightdash_list_spaces', description: 'List all spaces in a project', inputSchema: zodToJsonSchema(ListSpacesRequestSchema), },