color_elements
Assign distinct colors to Revit elements by category and parameter values to visualize data patterns in the current view, using gradient schemes or custom colors.
Instructions
Color elements in the current view based on a category and parameter value. Each unique parameter value gets assigned a distinct color.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| categoryName | Yes | The name of the Revit category to color (e.g., 'Walls', 'Doors', 'Rooms') | |
| parameterName | Yes | The name of the parameter to use for grouping and coloring elements | |
| useGradient | No | Whether to use a gradient color scheme instead of random colors | |
| customColors | No | Optional array of custom RGB colors to use for specific parameter values |
Implementation Reference
- src/tools/color_elements.ts:32-82 (handler)The tool execution handler that connects to Revit, sends 'color_splash' command with parameters, and formats the success/error response into MCP content.async (args, extra) => { const params = args; try { const response = await withRevitConnection(async (revitClient) => { return await revitClient.sendCommand("color_splash", params); }); // Format the response into a more user-friendly output if (response.success) { const coloredGroups = response.results || []; let resultText = `Successfully colored ${response.totalElements} elements across ${response.coloredGroups} groups.\n\n`; resultText += "Parameter Value Groups:\n"; coloredGroups.forEach((group: any) => { const rgb = group.color; resultText += `- "${group.parameterValue}": ${group.count} elements colored with RGB(${rgb.r}, ${rgb.g}, ${rgb.b})\n`; }); return { content: [ { type: "text", text: resultText, }, ], }; } else { return { content: [ { type: "text", text: `Color operation failed: ${response.message}`, }, ], }; } } catch (error) { return { content: [ { type: "text", text: `Color operation failed: ${ error instanceof Error ? error.message : String(error) }`, }, ], }; } } );
- src/tools/color_elements.ts:9-31 (schema)Input schema using Zod for validating tool arguments: categoryName (string), parameterName (string), useGradient (boolean, optional default false), customColors (array of RGB objects, optional).{ categoryName: z .string() .describe("The name of the Revit category to color (e.g., 'Walls', 'Doors', 'Rooms')"), parameterName: z .string() .describe("The name of the parameter to use for grouping and coloring elements"), useGradient: z .boolean() .optional() .default(false) .describe("Whether to use a gradient color scheme instead of random colors"), customColors: z .array( z.object({ r: z.number().int().min(0).max(255), g: z.number().int().min(0).max(255), b: z.number().int().min(0).max(255), }) ) .optional() .describe("Optional array of custom RGB colors to use for specific parameter values"), },
- src/tools/color_elements.ts:5-83 (registration)The registration function that calls server.tool to register the 'color_elements' tool with its name, description, input schema, and handler. This function is dynamically invoked from src/tools/register.ts.export function registerColorElementsTool(server: McpServer) { server.tool( "color_elements", "Color elements in the current view based on a category and parameter value. Each unique parameter value gets assigned a distinct color.", { categoryName: z .string() .describe("The name of the Revit category to color (e.g., 'Walls', 'Doors', 'Rooms')"), parameterName: z .string() .describe("The name of the parameter to use for grouping and coloring elements"), useGradient: z .boolean() .optional() .default(false) .describe("Whether to use a gradient color scheme instead of random colors"), customColors: z .array( z.object({ r: z.number().int().min(0).max(255), g: z.number().int().min(0).max(255), b: z.number().int().min(0).max(255), }) ) .optional() .describe("Optional array of custom RGB colors to use for specific parameter values"), }, async (args, extra) => { const params = args; try { const response = await withRevitConnection(async (revitClient) => { return await revitClient.sendCommand("color_splash", params); }); // Format the response into a more user-friendly output if (response.success) { const coloredGroups = response.results || []; let resultText = `Successfully colored ${response.totalElements} elements across ${response.coloredGroups} groups.\n\n`; resultText += "Parameter Value Groups:\n"; coloredGroups.forEach((group: any) => { const rgb = group.color; resultText += `- "${group.parameterValue}": ${group.count} elements colored with RGB(${rgb.r}, ${rgb.g}, ${rgb.b})\n`; }); return { content: [ { type: "text", text: resultText, }, ], }; } else { return { content: [ { type: "text", text: `Color operation failed: ${response.message}`, }, ], }; } } catch (error) { return { content: [ { type: "text", text: `Color operation failed: ${ error instanceof Error ? error.message : String(error) }`, }, ], }; } } ); }