Check connectivity to Revit, retrieve Revit version, MLabs plugin status, and active document/view details. (Full session diagnostic equivalent to mlabs_ping).

This tool accepts no arguments. Pass an empty object {}.

Example Invocation

{}

Check connectivity to Revit, retrieve Revit version, MLabs plugin status, and active document/view details. (Equivalent to ping).

This tool accepts no arguments. Pass an empty object {}.

Example Invocation

{}

Retrieve active Revit document title, path, active view name, and project status.

This tool accepts no arguments. Pass an empty object {}.

Example Invocation

{}

Retrieve a list of all documents/projects currently open in the Revit session, including active status, title, path, and worksharing state.

This tool accepts no arguments. Pass an empty object {}.

Example Invocation

{}

Open a Revit project (.rvt) or family (.rfa) file. Can open and activate in UI or open in background memory.

Parameters

Example Invocation

{
  "file_path": "C:\\Projects\\MedicalCenter_Phase2.rvt",
  "activate": true,
  "detach_from_central": false
}

Save or Synchronize with Central for the active Revit project or a specified project by title.

Parameters

Example Invocation

{
  "sync_central": true,
  "compact": true,
  "comment": "Aligned sanitary piping layout on Level 2"
}

Close a specific Revit project by title or close all open projects except a specified project (close_all_except).

Parameters

Example Invocation

{
  "project_title": "Site_Context.rvt",
  "save_changes": false
}

List non-template views in the active Revit project with optional filtering by view_type and search_keyword. Includes token protection with max_results (default 100).

Parameters

Example Invocation

{
  "view_type": "FloorPlan",
  "search_keyword": "HVAC",
  "max_results": 25,
  "offset": 0
}

Retrieve a list of all currently open UI view windows in the active Revit document, indicating which one is active. To search or list all views in the project (including closed views), use ‘list_views’.

This tool accepts no arguments. Pass an empty object {}.

Example Invocation

{}

Switch the active viewport in Revit to a specified view by view_id or view_name. Works for ANY non-template view in the project (FloorPlan, Section, 3D, Schedule, Sheet), even if not currently open in tabs.

Parameters

Example Invocation

{
  "view_name": "Level 1 - Mechanical Plan"
}

Close views in the active Revit document. Set ‘close_inactive’ to true to close all inactive views (equivalent to Revit’s native Close Inactive Views), or specify ‘view_id’ / ‘view_name’ to close a specific open view.

Parameters

Example Invocation

{
  "close_inactive": true
}

Retrieve detailed properties, geometry bounds, and parameters of currently selected elements in the active Revit project (Revit Lookup style).

Parameters

Example Invocation

{}

Inspect deep properties, parameters, and type information of specific elements by their Revit Element IDs (Int64/long).

Parameters

Example Invocation

{
  "element_ids": [
    1048291,
    1048295
  ],
  "include_parameters": true,
  "include_type_parameters": true,
  "param_filter": "Dimension"
}

List summary information of elements visible in the active view, filtered by category with pagination.

Parameters

Example Invocation

{
  "category_name": "Pipes",
  "limit": 50,
  "offset": 0
}

Search and filter elements by parameter name and value. Supports view scope, category filter, exact/contains/regex matching, and safety limit (Constraint #4).

Parameters

Example Invocation

{
  "parameter_name": "Comments",
  "filter_value": "VAV-101",
  "match_mode": "contains",
  "category_name": "Ducts"
}

Highlight, select, and optionally zoom-to-fit specified elements in the active view so the user can verify changes visually.

Parameters

Example Invocation

{
  "element_ids": [
    1048291,
    1048295
  ],
  "zoom_to_fit": true
}

Capture high-quality snapshot of the active view (or a specified view by ID) using Revit API native export (DPI 150, 1280-1568px). NOTE: For 2D Plan/Section/Elevation and 3D Model views only. For Schedules and Sheets, use ‘capture_revit_screenshot’.

Parameters

Example Invocation

{
  "pixel_size": 1568
}

Capture actual viewport/schedule screenshot from Revit UI (drawing area or full window) via GDI+ CopyFromScreen. REQUIRED for visual inspection of Schedules and Sheets, or when capturing the entire Revit UI.

Parameters

Example Invocation

{
  "capture_scope": "viewport",
  "target_view_id": 2049182
}

Isolates specified elements in a 3D bounding box snapshot and exports an image. Wraps all modifications in a TransactionGroup with RollBack to protect the Undo stack (Constraint #3).

Parameters

Example Invocation

{
  "element_ids": [
    1048291,
    1048295
  ],
  "padding_mm": 500.0,
  "pixel_size": 1440
}

List all Model Component Schedules (Pipes, Ducts, Equipment, etc.) in the project or placed on a specific sheet (Constraint #2).

Parameters

Example Invocation

{
  "sheet_id": 3058291
}

Read table column structure and cell text from a Model Component Schedule with formatted cell extraction, header cleaning, and optional export engine.

Parameters

Example Invocation

{
  "schedule_name": "Pipe Schedule - Level 1",
  "max_rows": 100
}

Audit and extract all active Warnings in the Revit project with grouped statistics, severity, and related element IDs (Int64/long).

Parameters

Example Invocation

{
  "severity_filter": "warning",
  "limit": 50
}

Audit MEP model integrity: detect open (unconnected) pipe/duct ends, check slopes, and unassigned MEP systems.

Parameters

Example Invocation

{
  "category": "Pipes",
  "check_open_connectors": true,
  "check_slope": true,
  "limit": 100
}

Modify a single parameter value on an element with automatic unit conversion, dry-run preview, and Type Parameter protection (Constraint #5). For numeric length/size parameters, ‘unit’ defaults to Document units or ‘mm’ (never raw feet). Specify ‘unit’ (e.g. ‘mm’, ‘m’, ‘deg’) explicitly for maximum precision.

Parameters

Example Invocation

{
  "element_id": 1048291,
  "parameter_name": "Comments",
  "new_value": "Inspected & Approved",
  "allow_type_parameter": false,
  "dry_run": false
}

Modify multiple element parameters atomically within a single Transaction. Supports dry-run validation, unit safety (defaults to doc units or mm), and type parameter safeguards (Constraint #5).

Parameters

Example Invocation

{
  "transaction_name": "Update Pipe Insulation",
  "allow_type_parameter": false,
  "dry_run": false,
  "stop_on_first_error": false,
  "updates": [
    {
      "element_id": 1048291,
      "parameter_name": "Insulation Thickness",
      "new_value": 25.0,
      "unit": "mm"
    },
    {
      "element_id": 1048295,
      "parameter_name": "Insulation Thickness",
      "new_value": 25.0,
      "unit": "mm"
    }
  ]
}

Visual-First SoM Pre-inspection: Scans active view for elements of a given category (default: ‘Plumbing Fixtures’), temporarily labels them P1..Pn, exports a high-resolution PNG snapshot for AI spatial reasoning, and rolls back the transaction leaving model untouched.

Parameters

Example Invocation

{
  "category_name": "Plumbing Fixtures",
  "pixel_size": 1440
}

Batch tags elements in the active view (with leader enabled). Supports specific element IDs or all visible elements of category. Returns placed tag metadata and an updated snapshot image.

Parameters

Example Invocation

{
  "category_name": "Plumbing Fixtures",
  "element_ids": [
    1048291,
    1048295
  ],
  "leader_mode": "attached",
  "initial_offset_mm": 350.0,
  "offset_direction": "top_right",
  "capture_snapshot": true
}

Inspects existing tags in active view (by host category or tag category). Returns precise TagHeadPosition, LeaderElbow, LeaderEnd, bounding box size, and view snapshot.

Parameters

Example Invocation

{
  "category_name": "Plumbing Fixtures",
  "pixel_size": 1440
}

Applies batch spatial coordinates to TagHead and LeaderElbow. Accepts coordinates in millimeters (default) or internal feet. Returns updated tag status and fresh verification snapshot.

Parameters

Example Invocation

{
  "in_millimeters": true,
  "auto_perpendicular": true,
  "capture_verification": true,
  "adjustments": [
    {
      "tag_id": 1059382,
      "head_x_mm": 12500.0,
      "head_y_mm": 8400.0,
      "elbow_x_mm": 12200.0,
      "elbow_y_mm": 8400.0
    }
  ]
}

Snaps tag leaders in the active view to 90-degree orthogonal perpendicular angles with Attached End. Based on MLabs MakePerpendicular algorithm. Accepts specific tag IDs or all tags in active view.

Parameters

Example Invocation

{
  "category_name": "Plumbing Fixtures",
  "elbow_type": "horizontal_first",
  "capture_verification": true
}

Visual-First Inspection (SoM): Detects all visible walls in active view, classifies their orientation, temporarily tags them W1..Wn at midpoints with boundary markers [TOP],[BOTTOM],[LEFT],[RIGHT], exports a high-res PNG, and rolls back transaction leaving the model untouched.

Parameters

Example Invocation

{
  "pixel_size": 1440
}

Creates multi-segment continuous chain dimensions for grouped parallel walls from Exterior and Interior faces, projects line onto view plane, auto-staggers narrow segment texts (<=450mm), and optionally stacks an overall dimension.

Parameters

Example Invocation

{
  "chains": [
    {
      "wall_ids": [
        1048100,
        1048105,
        1048110
      ],
      "dimension_face": "exterior",
      "offset_distance_mm": 800.0,
      "chain_type": "continuous"
    }
  ]
}

Fine-tune dimension lines and segment text positions: move dimension line perpendicular to its axis, offset specific segment TextPosition, stagger narrow segments, or delete erroneous dimensions.

Parameters

Example Invocation

{
  "adjustments": [
    {
      "dimension_id": 2049182,
      "action": "move_line",
      "line_offset_delta_mm": 200.0
    }
  ]
}

Query available FamilySymbols, WallTypes, FloorTypes, PipeTypes, DuctTypes, and Levels in the active project. Returns placement_type (OneLevelBased, OneLevelBasedHosted, WorkPlaneBased, etc.) and is limited to max_results (default 50) to prevent token overflow.

Parameters

Example Invocation

{
  "category_name": "Walls",
  "limit": 50
}

Batch-create linear elements (Walls, Beams, Pipes, Ducts, CableTrays, Conduits, Grids, ModelLines) inside a single Transaction. Supports path_points for multi-segment MEP with auto_connect_fittings: true (elbows), location_line and is_structural for Walls, and silent failure handling.

Parameters

Example Invocation

{
  "dry_run": false,
  "items": [
    {
      "category": "Walls",
      "type_id": 349182,
      "level_id": 1024,
      "start_point": {
        "x": 0.0,
        "y": 0.0,
        "z": 0.0
      },
      "end_point": {
        "x": 6000.0,
        "y": 0.0,
        "z": 0.0
      },
      "height_mm": 3000.0,
      "is_structural": false,
      "location_line": "WallCenterline"
    }
  ]
}

Batch-create profile/boundary elements (Floors, Ceilings) from closed polygonal boundaries inside a single Transaction. Supports height_offset_mm, is_structural for floors, multi-version .NET wrapping, and silent failure handling.

Parameters

Example Invocation

{
  "dry_run": false,
  "items": [
    {
      "category": "Floors",
      "type_id": 482910,
      "level_id": 1024,
      "height_offset_mm": 0.0,
      "is_structural": false,
      "boundary_polygon_mm": [
        {
          "x": 0.0,
          "y": 0.0
        },
        {
          "x": 6000.0,
          "y": 0.0
        },
        {
          "x": 6000.0,
          "y": 5000.0
        },
        {
          "x": 0.0,
          "y": 5000.0
        }
      ]
    }
  ]
}

Batch-place Family Instances (Doors, Windows, Columns, MEP Equipment, Terminals, Fixtures) inside a single Transaction. Discriminates FamilyPlacementType (OneLevelBased, OneLevelBasedHosted, WorkPlaneBased, TwoLevelsBased), snaps hosted items to wall axis, and supports rotation.

Parameters

Example Invocation

{
  "dry_run": false,
  "items": [
    {
      "type_id": 591823,
      "level_id": 1024,
      "location": {
        "x": 3000.0,
        "y": 0.0,
        "z": 0.0
      },
      "host_id": 1048100,
      "rotation_degrees": 0.0
    }
  ]
}

Batch-create architectural Rooms and place RoomTags at interior points within enclosed spaces. Includes pre-check for existing rooms (GetRoomAtPoint), mandatory doc.Regenerate() to compute area boundaries, and automatic cleanup (doc.Delete) for unenclosed spaces (Area <= 1e-4) to prevent model corruption.

Parameters

Example Invocation

{
  "level_id": 1024,
  "rooms": [
    {
      "name": "Mechanical Room",
      "number": "M-101",
      "point": {
        "x": 2500.0,
        "y": 2500.0,
        "z": 0.0
      },
      "tag_room": true
    }
  ]
}

Imports an external 2D raster/vector file (PDF, PNG, JPG, BMP) into a Revit view as an image underlay. NOTE: For existing DWG/DXF CAD files already linked/imported in Revit, use ‘list_dwg_underlays’ and CAD-to-BIM tools instead. Places the image at BoxPlacement.BottomLeft to synchronize coordinate systems with the AI Agent, sets DrawLayer to Background, and automatically initializes an in-memory CalibrationSession for pixel-to-model coordinate mapping.

Parameters

Example Invocation

{
  "file_path": "C:\\Drawings\\Architectural_Plan_L1.png",
  "view_id": 2049182
}

Calibrates in-memory pixel-to-model transformation using two reference points (e.g. Grid A-1 and Grid B-1). Computes precise scale factor (mm/pixel) and origin offset in C#, completely eliminating LLM floating-point calculation errors.

Parameters

Example Invocation

{
  "image_width_px": 3840.0,
  "image_height_px": 2160.0,
  "point1": {
    "pixel_x": 420.0,
    "pixel_y": 680.0,
    "model_x_mm": 0.0,
    "model_y_mm": 0.0
  },
  "point2": {
    "pixel_x": 2840.0,
    "pixel_y": 680.0,
    "model_x_mm": 18000.0,
    "model_y_mm": 0.0
  }
}

Inspect all MEP connectors (Piping, HVAC, Electrical) on a specified element or the currently selected elements in Revit. Returns connector origin (in mm), direction vector (BasisZ), domain, connection status, profile shape, size, and system type.

Parameters

Example Invocation

{
  "element_id": 1048291,
  "open_only": true
}

Connect two MEP elements (Pipes, Ducts, Cable Trays, Conduits) orthogonally with automatic elbow fittings using 3D orthogonal routing. Supports connecting elements pre-selected by the user in Revit or specified via element1_id & element2_id. Implements 6-attempt auto-retry loop with collision avoidance and silent failure preprocessor.

Parameters

Example Invocation

{
  "element1_id": 1048291,
  "element2_id": 1048295,
  "max_attempts": 6,
  "dry_run": false
}

Finds all DWG/DXF Link and Import instances already present/visible in the active Plan View (Step 1 of CAD-to-BIM pipeline). For importing external PDF or image files, use ‘import_drawing_underlay’. Filters out hidden imports and evaluates Visibility/Graphics (VG) layer visibility. Returns file names, Element IDs, Link status, base levels, and layer visibility counts so the user/agent can choose which file to process.

Parameters

Example Invocation

{}

Inspects the CAD Layers and geometric breakdown of a selected DWG/DXF instance. Traverses nested GeometryInstances (CAD Blocks) recursively with Transform accumulation, handles Layer ‘0’ inheritance, processes both Curves (Line/Arc) and PolyLines, and identifies which layers are visible in the view’s VG overrides with heuristic suggestions for Walls, Columns, Floors, and Stairs.

Parameters

Example Invocation

{
  "instance_id": 3058291
}

Extracts, rectifies, and groups 2D CAD geometry (Walls, Columns, Floors, Stairs) from a DWG/DXF instance into an In-Memory C# Cache. Applies 1D Overlap Interval Projection for double-line walls, rectangle/circle detection for columns, closed-loop extraction for floors, and riser clustering for stairs. Returns a compact statistical summary grouped by wall thickness and column size with a unique ‘extraction_id’ (zero LLM token bottlenecks).

Parameters

Example Invocation

{
  "instance_id": 3058291,
  "selected_layers": [
    "A-WALL",
    "S-COLS"
  ],
  "simplify_tolerance_mm": 5.0
}

Retrieves the statistical summary of a previously extracted DWG geometry session from in-memory cache.

Parameters

Example Invocation

{}

Generates BIM elements (Walls, Columns, Floors, Stairs) directly from an In-Memory DWG Extraction Cache session. Takes extraction_id, Level IDs, and Type mappings, creates elements inside a unified TransactionGroup with silent failure preprocessor, and supports dry_run simulation rollback (zero LLM token bottlenecks, zero coordinate round-tripping).

Parameters

Example Invocation

{
  "level_id": 1024,
  "dry_run": false,
  "element_mappings": [
    {
      "cad_layer": "A-WALL",
      "bim_category": "Walls",
      "type_id": 349182,
      "height_mm": 3200.0
    }
  ]
}