Revit MCP Server

Instructions

Implementation Reference

• src/tools/get_current_view_elements.ts:31-67 (handler)

  The main handler function that processes input arguments, prepares parameters, connects to Revit via withRevitConnection, sends the 'get_current_view_elements' command, and formats the response or error message.

  async (args, extra) => {
    const params = {
      modelCategoryList: args.modelCategoryList || [],
      annotationCategoryList: args.annotationCategoryList || [],
      includeHidden: args.includeHidden || false,
      limit: args.limit || 100,
    };
  
    try {
      const response = await withRevitConnection(async (revitClient) => {
        return await revitClient.sendCommand(
          "get_current_view_elements",
          params
        );
      });
  
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response, null, 2),
          },
        ],
      };
    } catch (error) {
      return {
        content: [
          {
            type: "text",
            text: `get current view elements failed: ${
              error instanceof Error ? error.message : String(error)
            }`,
          },
        ],
      };
    }
  }

• src/tools/get_current_view_elements.ts:9-30 (schema)

  Zod input schema defining optional parameters for filtering elements by model/annotation categories, including hidden elements, and limiting results.

  {
    modelCategoryList: z
      .array(z.string())
      .optional()
      .describe(
        "List of Revit model category names (e.g., 'OST_Walls', 'OST_Doors', 'OST_Floors')"
      ),
    annotationCategoryList: z
      .array(z.string())
      .optional()
      .describe(
        "List of Revit annotation category names (e.g., 'OST_Dimensions', 'OST_WallTags', 'OST_TextNotes')"
      ),
    includeHidden: z
      .boolean()
      .optional()
      .describe("Whether to include hidden elements in the results"),
    limit: z
      .number()
      .optional()
      .describe("Maximum number of elements to return"),
  },

• src/tools/get_current_view_elements.ts:5-69 (registration)

  Registration function that adds the 'get_current_view_elements' tool to the MCP server using server.tool(), providing name, description, schema, and handler. This is dynamically called from src/tools/register.ts.

  export function registerGetCurrentViewElementsTool(server: McpServer) {
    server.tool(
      "get_current_view_elements",
      "Get elements from the current active view in Revit. You can filter by model categories (like Walls, Floors) or annotation categories (like Dimensions, Text). Use includeHidden to show/hide invisible elements and limit to control the number of returned elements.",
      {
        modelCategoryList: z
          .array(z.string())
          .optional()
          .describe(
            "List of Revit model category names (e.g., 'OST_Walls', 'OST_Doors', 'OST_Floors')"
          ),
        annotationCategoryList: z
          .array(z.string())
          .optional()
          .describe(
            "List of Revit annotation category names (e.g., 'OST_Dimensions', 'OST_WallTags', 'OST_TextNotes')"
          ),
        includeHidden: z
          .boolean()
          .optional()
          .describe("Whether to include hidden elements in the results"),
        limit: z
          .number()
          .optional()
          .describe("Maximum number of elements to return"),
      },
      async (args, extra) => {
        const params = {
          modelCategoryList: args.modelCategoryList || [],
          annotationCategoryList: args.annotationCategoryList || [],
          includeHidden: args.includeHidden || false,
          limit: args.limit || 100,
        };
  
        try {
          const response = await withRevitConnection(async (revitClient) => {
            return await revitClient.sendCommand(
              "get_current_view_elements",
              params
            );
          });
  
          return {
            content: [
              {
                type: "text",
                text: JSON.stringify(response, null, 2),
              },
            ],
          };
        } catch (error) {
          return {
            content: [
              {
                type: "text",
                text: `get current view elements failed: ${
                  error instanceof Error ? error.message : String(error)
                }`,
              },
            ],
          };
        }
      }
    );
  }