Pages Navigation and Editing
Working the graphical editor: opening pages, jumping to devices, layers, and reading/writing properties.
19 tools (all prefixed eplan_ when registered as MCP tools).
eplan_edit_open_page
Section titled “eplan_edit_open_page”eplan_edit_open_page(page_name: str, project_name: str=None, x: float=None, y: float=None)Open a specific page in the editor. Action: edit
Args: page_name: Page name to open project_name: Project path (optional) x: X coordinate to position cursor y: Y coordinate to position cursor
eplan_edit_goto_device
Section titled “eplan_edit_goto_device”eplan_edit_goto_device(device_name: str, project_name: str=None)Navigate to a device in the project. Action: edit
eplan_edit_open_layout_space
Section titled “eplan_edit_open_layout_space”eplan_edit_open_layout_space(installation_space: str, project_name: str=None)Open a layout/installation space. Action: edit
eplan_close_pages
Section titled “eplan_close_pages”eplan_close_pages()Close all selected pages in the editor. Action: XGedClosePage
eplan_redraw_ged
Section titled “eplan_redraw_ged”eplan_redraw_ged()Redraw the graphical editor. Action: gedRedraw
Note: This action only works interactively. Under QuietMode (which this server always forces) the GED is not redrawn and the action returns FALSE.
eplan_get_selected_pages
Section titled “eplan_get_selected_pages”eplan_get_selected_pages()Get selected pages. Action: selectionset
The result is returned in the calling context parameter “PAGES” (page names separated by “;”, e.g. “=AP+ST1/1;=AP+ST1/2”).
eplan_preview_page
Section titled “eplan_preview_page”eplan_preview_page(page_name: str=None, project_name: str=None, macro_name: str=None, open: bool=True)Open or close the preview of a project page or macro. Action: XSDPreviewAction
Args: page_name: Page name to preview (optional) project_name: Project path (optional) macro_name: Full path to a window/page macro (optional, with extension) open: True to open the preview, False to close it (maps to SHOW=1/0)
Note: If both page_name and macro_name are empty, all project pages are shown in the preview.
eplan_navigate_to_eec
Section titled “eplan_navigate_to_eec”eplan_navigate_to_eec(object_id: str)Navigate to object in EPLAN Engineering Configuration. Action: navigateToEEC
Args: object_id: Object ID in the EEC to navigate to (parameter EECOBJECTID).
eplan_change_layer
Section titled “eplan_change_layer”eplan_change_layer(layer_name: str=None, visible: bool=None, printed: bool=None, text_height: float=None, color_id: int=None, transparency: float=None, project_name: str=None)Change graphical layer properties. Action: changelayer
Args: layer_name: Name of the layer (parameter LAYER). visible: Whether the layer is visible (parameter VISIBLE). printed: Whether the layer is printed (parameter PRINTED). text_height: Text height of the layer (parameter TEXTHEIGHT). color_id: Color ID of the layer (parameter COLORID). transparency: Transparency of the layer (parameter TRANSPARENCY). project_name: Project path (optional). If omitted, the selected project is used.
eplan_export_graphical_layer_table
Section titled “eplan_export_graphical_layer_table”eplan_export_graphical_layer_table(export_file: str, project_name: str=None)Export graphical layer table. Action: graphicallayertable
eplan_import_graphical_layer_table
Section titled “eplan_import_graphical_layer_table”eplan_import_graphical_layer_table(import_file: str, project_name: str=None)Import graphical layer table. Action: graphicallayertable
eplan_get_project_property
Section titled “eplan_get_project_property”eplan_get_project_property(property_id: str, property_index: int=0)Get a special property of the current project. Action: XEsGetProjectPropertyAction
Note: This action operates on the CURRENT project (no PROJECTNAME parameter). The value is returned in the calling-context parameter “PropertyValue”.
Args: property_id: Property identifier name or number (parameter PropertyId). Values defined in Eplan.EplApi.DataModel.Properties. property_index: Property index (default 0, parameter PropertyIndex).
eplan_set_project_property
Section titled “eplan_set_project_property”eplan_set_project_property(property_id: str, value: str, property_index: int=0)Set a special property of the current project. Action: XEsSetProjectPropertyAction
Note: This action operates on the CURRENT project (no PROJECTNAME parameter).
Args: property_id: Property identifier name or number (parameter PropertyId). value: Value to set (parameter PropertyValue). property_index: Property index (default 0, parameter PropertyIndex).
eplan_get_page_property
Section titled “eplan_get_page_property”eplan_get_page_property(property_id: str, property_index: int=0)Get a special property of the first selected page. Action: XEsGetPagePropertyAction
Note: This action operates on the first SELECTED page (no PAGENAME parameter). The value is returned in the calling-context parameter “PropertyValue”.
Args: property_id: Property identifier name or number (parameter PropertyId). property_index: Property index (default 0, parameter PropertyIndex).
eplan_set_page_property
Section titled “eplan_set_page_property”eplan_set_page_property(property_id: str, value: str, property_index: int=0)Set a special property of the selected pages. Action: XEsSetPagePropertyAction
Note: This action operates on the SELECTED pages (no PAGENAME parameter).
Args: property_id: Property identifier name or number (parameter PropertyId). value: Value to set (parameter PropertyValue). property_index: Property index (default 0, parameter PropertyIndex).
eplan_get_property
Section titled “eplan_get_property”eplan_get_property(property_id: str=None, property_ident_name: str=None, property_index: int=0)Get a property from selected objects. Action: XEsGetPropertyAction
Args: property_id: Property identifier number (from Eplan.EplApi.DataModel.Properties) property_ident_name: Property identifier name (for user-defined properties) property_index: Property index (default 0)
Note: Either property_id or property_ident_name must be provided. Returns the property value in the result.
eplan_set_property
Section titled “eplan_set_property”eplan_set_property(value: str, property_id: str=None, property_ident_name: str=None, property_index: int=0)Set a property on selected objects. Action: XEsSetPropertyAction
Args: value: Value to set property_id: Property identifier number property_ident_name: Property identifier name (for user-defined properties) property_index: Property index (default 0)
Note: Either property_id or property_ident_name must be provided.
eplan_export_user_properties
Section titled “eplan_export_user_properties”eplan_export_user_properties(export_file: str, project_name: str=None)Export user properties to file. Action: XEsUserPropertiesExportAction
Live-verified 2026-09-04: the previous wrapper sent PROJECTNAME/EXPORTFILE, neither a real parameter of this action - it documents XMLFile and Project. Audit #42 item 2.
Args: export_file: Output XML file path. project_name: Full project name/path (optional). If omitted, the selected project is used or EPLAN shows a project picker.
eplan_import_user_properties
Section titled “eplan_import_user_properties”eplan_import_user_properties(import_file: str, project_name: str=None, overwrite: bool=None)Import user properties from file. Action: XEsUserPropertiesImportAction
Live-verified 2026-09-04: the previous wrapper sent PROJECTNAME/IMPORTFILE, neither a real parameter of this action - it documents XMLFile and Project. Audit #42 item 2.
Args: import_file: Input XML file path. If omitted, EPLAN shows a file picker. project_name: Full project name/path (optional). If omitted, the selected project is used or EPLAN shows a project picker. overwrite: Overwrite existing properties (optional). If omitted, EPLAN shows a confirmation dialog - pass this explicitly for an unattended call.
This page is generated from the docstrings in Canary-ECAD/eplan-mcp.