operate_element

Instructions

Implementation Reference

• src/tools/operate_element.ts:32-61 (handler)

  Handler function that sends the 'operate_element' command with parameters to the Revit client via withRevitConnection and returns the response as text content or an error message.

  async (args, extra) => {
    const params = args;
  
    try {
      const response = await withRevitConnection(async (revitClient) => {
        return await revitClient.sendCommand(
          "operate_element",
          params
        );
      });
  
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response, null, 2),
          },
        ],
      };
    } catch (error) {
      return {
        content: [
          {
            type: "text",
            text: `Operate elements failed: ${error instanceof Error ? error.message : String(error)}`,
          },
        ],
      };
    }
  }

• src/tools/operate_element.ts:9-31 (schema)

  Zod schema defining the input parameters for the 'operate_element' tool: elementIds array, action string, optional transparencyValue and colorValue.

  {
    data: z
      .object({
        elementIds: z
          .array(z
            .number()
            .describe("A valid Revit element ID to operate on")
          )
          .describe("Array of Revit element IDs to perform the specified action on"),
        action: z
          .string()
          .describe("The operation to perform on elements. Valid values: Select, SelectionBox, SetColor, SetTransparency, Delete, Hide, TempHide, Isolate, Unhide, ResetIsolate, Highlight. Select enables direct element selection in the active view. SelectionBox allows selection of elements by drawing a rectangular window in the view. SetColor changes the color of elements (requires elementColor parameter). SetTransparency adjusts element transparency (requires transparencyValue parameter). Highlight is a convenience operation that sets elements to red color (internally calls SetColor with red). Delete permanently removes elements from the project. Hide makes elements invisible in the current view until explicitly shown. TempHide temporarily hides elements in the current view. Isolate displays only selected elements while hiding all others. Unhide reveals previously hidden elements. ResetIsolate restores normal visibility to the view."),
        transparencyValue: z
          .number()
          .default(50)
          .describe("Transparency value (0-100) for SetTransparency action. Higher values increase transparency."),
        colorValue: z
          .array(z.number())
          .default([255, 0, 0])
          .describe("RGB color values for SetColor action. Default is red [255,0,0].")
      })
      .describe("Parameters for operating on Revit elements with specific actions"),
  },

• src/tools/operate_element.ts:5-63 (registration)

  Function that registers the 'operate_element' MCP tool on the server, providing name, description, schema, and handler. This function is dynamically called by src/tools/register.ts.

  export function registerOperateElementTool(server: McpServer) {
    server.tool(
      "operate_element",
      "Operate on Revit elements by performing actions such as select, selectionBox, setColor, setTransparency, delete, hide, etc.",
      {
        data: z
          .object({
            elementIds: z
              .array(z
                .number()
                .describe("A valid Revit element ID to operate on")
              )
              .describe("Array of Revit element IDs to perform the specified action on"),
            action: z
              .string()
              .describe("The operation to perform on elements. Valid values: Select, SelectionBox, SetColor, SetTransparency, Delete, Hide, TempHide, Isolate, Unhide, ResetIsolate, Highlight. Select enables direct element selection in the active view. SelectionBox allows selection of elements by drawing a rectangular window in the view. SetColor changes the color of elements (requires elementColor parameter). SetTransparency adjusts element transparency (requires transparencyValue parameter). Highlight is a convenience operation that sets elements to red color (internally calls SetColor with red). Delete permanently removes elements from the project. Hide makes elements invisible in the current view until explicitly shown. TempHide temporarily hides elements in the current view. Isolate displays only selected elements while hiding all others. Unhide reveals previously hidden elements. ResetIsolate restores normal visibility to the view."),
            transparencyValue: z
              .number()
              .default(50)
              .describe("Transparency value (0-100) for SetTransparency action. Higher values increase transparency."),
            colorValue: z
              .array(z.number())
              .default([255, 0, 0])
              .describe("RGB color values for SetColor action. Default is red [255,0,0].")
          })
          .describe("Parameters for operating on Revit elements with specific actions"),
      },
      async (args, extra) => {
        const params = args;
  
        try {
          const response = await withRevitConnection(async (revitClient) => {
            return await revitClient.sendCommand(
              "operate_element",
              params
            );
          });
  
          return {
            content: [
              {
                type: "text",
                text: JSON.stringify(response, null, 2),
              },
            ],
          };
        } catch (error) {
          return {
            content: [
              {
                type: "text",
                text: `Operate elements failed: ${error instanceof Error ? error.message : String(error)}`,
              },
            ],
          };
        }
      }
    );
  }