AI Power Tools for Sparx EA Docs Release 3.6.4

All operations A–Z

Every operation of the AI Power Tools MCP Server for Sparx EA, in alphabetical order. Each links to its entry on its tool's page.

Operation Tool What it does Changes the model Logic
add_connectors_to_diagram_bulk ea_diagram Adds the per-diagram record for connectors whose two ends are both on the diagram Yes (diagram only) Deterministic
add_element_to_diagram ea_diagram Places one existing element at a given position and size Yes (diagram placement) Deterministic
add_elements_to_diagram_bulk ea_diagram Places many existing elements at once, skipping any already on the diagram, with optional positions, stacking numbers and automatic layout Yes (diagram placement; may add connector records) Deterministic
add_image ea_diagram Loads an image file into the model's image library and returns its image id Yes Deterministic
add_parameter ea_model Adds a parameter to an operation and confirms it by reading it back Yes Deterministic
aggregate_portfolio ea_repository Groups every element of one stereotype by the value of one tagged value and returns the groups with counts, largest first No Deterministic
apply_baseline ea_repository Restores a package and its subtree to a baseline, then checks by comparing again that nothing differs Yes: destructive. Overwrites package content Deterministic
assess_mdg_situation ea_mdg Classifies the repository's modeling-language situation into one of three scenarios and names a next skill No Rule-based
audit ea_validate Runs a ruleset against the model and returns every violation, each with the rule, severity, the element or connector, a message and the rule's short fix text No Deterministic
audit_diagram_descriptions ea_diagram Reports, diagram by diagram, whether the description is current, out of date, missing or edited, and what the text leaves out No Rule-based: compares names and fingerprints by fixed rules
build_business_layer ea_repository Builds the business tables as SQL Server views from a profile, all inside one transaction in their own schema, and writes the definition. For direct access it first checks that the database holds an EA repository and that the account has the rights it needs, and changes nothing if either check fails No. Writes views into the target database, which with direct access is the EA repository's own database Deterministic
build_reporting_database ea_repository Reads EA's tables through EA, cuts the packages the profile leaves out, and reports a preflight. Unless you asked for the preflight only, or the preflight found a blocking defect, it loads the reporting database and builds the business views over it, or writes the rows for Parquet. Keeps this run's extract beside the profile No. Writes a separate database or files Deterministic
check_business_layer ea_repository Checks a built business layer without changing it: whether it aligns with the technology's metamodel and, by default, whether every value matches an independent read through EA No Deterministic
check_for_updates ea_repository Reports whether a newer AI Power Tools version exists, with download and release-notes links, how AI Power Tools was installed on this machine, and the upgrade steps for that installation No Deterministic
clear_element_image ea_diagram Stops drawing one placed element as a picture on one diagram, keeping the artwork in the library Yes (diagram presentation only) Deterministic
close_project ea_repository Closes the open model without exiting EA No Deterministic
collapse_parallel_connectors ea_diagram Hides duplicate connectors between the same pair of elements so the relationship reads as one line. A dry run unless told to apply Only when applied, and then diagram presentation only Deterministic
compare_baseline ea_repository Compares the package as it is now with one of its baselines and returns an item-by-item, property-by-property difference No (it opens EA's own comparison view) Deterministic
create_attribute ea_model Adds an attribute to an element, optionally with type, default and properties Yes Deterministic
create_baseline ea_repository Takes a baseline of a package and its subtree, under a version label and optional note, and returns the new baseline's identifier Yes: adds a snapshot to the repository Deterministic
create_connector ea_model Creates one connector between two elements, after checking both exist Yes Deterministic
create_connectors_bulk ea_model Creates many connectors in one call, skipping duplicates Yes Deterministic
create_diagram ea_diagram Creates an empty diagram of a native EA base type in a package Yes Deterministic
create_diagram_description ea_diagram Writes the description of a diagram, or of every diagram in a package, when its notes are empty. A preview unless you say otherwise Yes (the diagram's notes and modified date) Deterministic
create_diagram_in_language ea_diagram Creates an empty diagram of a language-defined diagram type and binds the language's toolbox to it Yes Deterministic
create_element ea_model Creates one element from an EA base type, optionally with stereotype, properties and tagged values in one call Yes Deterministic
create_element_in_language ea_model Creates one element from a technology id and a stereotype name; the base type is looked up Yes Deterministic
create_elements_bulk ea_model Creates many elements in one call, skipping any that already exist Yes Deterministic
create_external_reference_element ea_model Creates a placeholder for an object held in another system, with four identifying tags Yes Deterministic
create_model ea_repository Creates a new, empty local model file (.qea) and opens it Yes: creates a new file Deterministic
create_operation ea_model Adds an operation (method) to an element Yes Deterministic
create_package ea_model Creates a package under a parent and optionally sets its properties Yes Deterministic
delete_attribute ea_model Deletes an attribute, identified by element number plus attribute number Yes: destructive Deterministic
delete_connector ea_model Deletes a connector Yes: destructive Deterministic
delete_connector_tagged_value ea_model Deletes one tag from a connector by name Yes: destructive Deterministic
delete_diagram ea_diagram Permanently deletes a diagram and its placements, keeping the elements and connectors it showed Yes (destructive) Deterministic
delete_element ea_model Deletes an element with its connectors, members and diagram placements Yes: destructive Deterministic
delete_operation ea_model Deletes an operation, identified by element number plus operation number Yes: destructive Deterministic
delete_package ea_model Deletes a package and everything inside it Yes: destructive Deterministic
delete_tagged_value ea_model Deletes one tag from an element by name Yes: destructive Deterministic
describe_table ea_analyze Returns the column names and types of one table, its key, the columns that need special quoting, and notes on the table's quirks. Works without EA running No Deterministic
duplicate_package ea_model Copies a package subtree, like EA's "Paste as New", giving every copied object a fresh GUID Yes Deterministic
execute_sql ea_analyze Runs a database statement against the repository through EA and returns the rows (and optionally EA's raw XML). Accepts selects and also statements that insert, update or delete Can. Yes, when the statement is a write and writes are permitted. Writes are permitted unless refused Deterministic
expand_parallel_connectors ea_diagram Un-hides every hidden connector on a diagram, restoring the detail view Yes (diagram presentation only) Deterministic
export_diagram_image ea_diagram Writes a diagram to an image file in a chosen format and returns no image data No (writes a file) Deterministic
export_diagram_to_visio ea_diagram Writes a diagram as an editable Microsoft Visio file No (returns or writes a file) Deterministic
export_xmi ea_repository Exports a package as an XMI file, then reads the file back and refuses to report success unless it is XMI and contains the package's content No (writes a file) Deterministic
find_composite_diagram_mismatches ea_model Audits a package, optionally with its whole subtree, for elements where the two halves disagree No Deterministic
find_diagrams_by_name ea_diagram Finds diagrams anywhere in the model by whole or partial name No Deterministic
find_elements_by_name ea_model Finds elements anywhere in the model by name, each with its package path No Deterministic
find_icon ea_diagram Searches EA's shipped icon libraries by name and ranks the matches No Rule-based: ranks matches by fixed rules
find_orphan_elements ea_model Finds elements with no connector at either end, optionally for one stereotype and one package subtree No Deterministic (a query; whether an orphan is decay is a judgment left to the AI and you)
find_packages_by_name ea_model Finds packages whose name contains the text, or equals it No Deterministic
find_paths ea_analyze Returns every shortest path between two elements, as alternating element and connector steps. Connectors are followed in both directions, and each step records whether it was crossed with or against its arrow No Deterministic
generate_report ea_repository Runs one of EA's report templates against a package and writes the document No (writes a file) Deterministic
get_connector ea_model Reads one connector by number or GUID, including role, cardinality and navigability of each end No Deterministic
get_connector_tags ea_model Returns every tag on a connector, merged from all the places EA keeps them No Deterministic
get_connectors_for_element_filtered ea_model Lists an element's connectors filtered by direction, connector type and stereotype No Deterministic
get_current_diagram ea_diagram Returns the diagram open and focused in EA, with its elements and connectors, or nothing if none is open No Deterministic
get_current_selection ea_model Reads which elements are selected on the diagram open in EA No Deterministic (reads the current selection in EA's window)
get_diagram ea_diagram Reads one diagram by id or GUID, with a picture. Optionally lists every placed element and connector with its geometry No Deterministic
get_diagram_display ea_diagram Reads a diagram's display settings, gathered from all three places No Deterministic
get_diagram_link ea_diagram Reads one connector's line style, color, width and visibility on one diagram No Deterministic
get_diagram_manifest ea_diagram Reads one diagram completely: its identity and language, every shape with the element it stands for, where it is stored and where it is drawn, what is inside what, every line with its route and labels, swimlanes, note links, the diagram's display settings, EA's own picture and a description No Deterministic
get_diagram_png ea_diagram Renders a diagram as PNG, returned inline and optionally also written to a file No Deterministic
get_diagram_svg ea_diagram Renders a diagram as SVG text, optionally also written to a file No Deterministic
get_element ea_model Reads one element by number or GUID, optionally with its attributes, operations, tags and connector numbers No Deterministic
get_element_business_view ea_analyze Returns one element in business language: its type as a display term, its tagged values as label and value pairs, and each of its connections as a short phrase ("uses", "used by") No Deterministic
get_element_tags ea_model Returns every tag on an element, merged from all the places EA keeps them No Deterministic
get_embedded_mdgs ea_mdg Lists every technology copy stored in the open model, one entry per copy, with its Location (Project or Model) and the id, name and version that copy declares. Also lists any entries in the older storage that EA 15 and 16 used. Returns no definitions No Deterministic
get_mdg_from_runtime ea_mdg Returns the stereotypes, tagged values and diagram types of one named technology that EA has actually loaded, says where the answer came from and whether the technology is enabled, or declines to answer No Deterministic
get_mdg_search_paths ea_mdg Returns the folders EA treats as technology search paths (Manage Technologies, Advanced tab). Optionally tests whether a given folder, such as a build output folder, is on one No Deterministic
get_package ea_model Reads one package by number or GUID, optionally with the identifiers of its child packages, elements and diagrams No Deterministic
get_package_manifest ea_diagram Reads every diagram in a package, and optionally the packages below it, with the elements shared by several diagrams described once No Deterministic
get_reporting_refresh ea_repository Reports a refresh's status (running, succeeded or failed) and, once it has finished, its full result or why it stopped No Deterministic
get_repository_info ea_repository Reports the open model's location, EA version, repository type, whether EA user security is on and who is signed in, the root packages, and any update notice No Deterministic
get_skill_update_diff ea_repository Returns the local and the latest published content of one skill file that has a conflict No Deterministic
get_traceability_tree ea_analyze Returns a rooted tree of everything reachable from an element along the chosen connector types, in one direction No Deterministic
get_updates_in_range ea_analyze Lists the elements, packages or diagrams created or modified in a date range, one row per item with name, type, owning package and modification time. Can be limited to elements, packages or diagrams, or return all three No Deterministic
get_user_activity ea_analyze Counts how many elements and diagrams each author last modified in a date range, with each author's latest modification time No Deterministic
import_xmi ea_repository Imports an XMI file into a package and reports how many items arrived Yes: adds content to the target package Deterministic
install_mdg ea_mdg Installs a technology. For the workstation, copies a technology file to the per-user folder and asks EA to refresh. For the model, either imports a technology file into the open model at Location: Project, or builds the technology from an MDG Technology package in the open model and imports it at Location: Model. Every model install is read back before it is reported Depends on the scope. Installing into the model: yes, adds the technology to the open model, and can remove a same-id copy at Location: Project when you ask. Installing for the workstation: no, writes a file in your user profile Deterministic
install_skills ea_repository Installs skills (and rulesets) from the public bundle. It declines when the plugin already supplies the skills No (writes files) Deterministic
launch_ea ea_repository Starts EA on this machine and waits up to 30 seconds for it to respond No Deterministic
layout_diagram ea_diagram Applies EA's automatic layout and repositions every placed element Yes (diagram geometry) Deterministic
list_attributes ea_model Lists an element's attributes No Deterministic
list_available_modeling_languages ea_mdg Lists the modeling languages the server can identify in the connected EA, each with id, version, how it learned of it, diagram types and whether EA has it loaded. Technologies stored in the model come first, with their Location and whether they are enabled. It is a known-id list, not an inventory No Deterministic
list_available_skills ea_repository Lists the skills in the public bundle and whether each works with the running server No Deterministic
list_baselines ea_repository Lists the baselines stored against one package No Deterministic
list_child_packages ea_model Lists a package's immediate children No Deterministic
list_connector_tagged_values ea_model Lists a connector's tags through EA's own list No Deterministic
list_connectors_for_element ea_model Lists every connector attached to an element, both directions No Deterministic
list_diagrams_in_package ea_diagram Lists the diagrams in a package, optionally including all child packages No Deterministic
list_ea_tables ea_analyze Lists every repository table the server knows, with its primary key column. Reads a built-in catalog, so it works without EA running No Deterministic
list_elements_in_package ea_model Lists the elements in a package, optionally including child packages No Deterministic
list_images ea_diagram Lists what the image library already holds, without the artwork No Deterministic
list_operations ea_model Lists an element's operations with their parameters No Deterministic
list_package_tree ea_model Walks the hierarchy beneath a package in a few queries, optionally with each package's diagrams and element count No Deterministic
list_registered_technologies ea_mdg Lists technologies roughly as EA's Manage Technologies dialog would: name, version, location and enabled state. A technology stored in the model is listed once per Location, with the version that copy declares. The same technology can appear more than once, once per location No Deterministic
list_root_packages ea_model Lists the top-level packages (model roots) No Deterministic
list_tagged_values ea_model Lists an element's tags through EA's own list No Deterministic
move_element ea_model Moves an element to a different package Yes Deterministic
neaten_diagram_objects ea_diagram Snaps near-aligned elements onto shared left and top lines, and optionally evens out the gaps in rows and columns Yes (diagram geometry) Deterministic
open_diagram ea_diagram Opens a diagram in the EA window and optionally returns a picture No Deterministic
open_model ea_repository Opens an existing model file by path, always issuing the open No Deterministic
open_project ea_repository Opens a model file in the running EA. If that model is already open nothing happens; if another is open, EA switches No Deterministic
parse_mdg_xml ea_mdg Reads an MDG technology file, or XML text, into the description. Remembers the technology for the rest of the session No Deterministic
prune_legacy_skills ea_repository Removes skill folders AI Power Tools installed earlier and has since renamed, withdrawn or relocated. A dry run unless told to apply No (deletes files when applied) Deterministic
publish_package_as_profile ea_mdg Exports a profile package from the model as a UML Profile file. It is the scriptable form of Specialize > Publish Technology > Publish Package as UML Profile. Every stereotype element in the package becomes a stereotype in the output No (writes a file) Deterministic
reload_diagram ea_diagram Forces EA to redraw a diagram from the model No Deterministic
remove_business_layer ea_repository Drops every view in the profile's schema, then the schema. EA's tables, and a reporting database's copied tables, are not touched No. Drops the views Deterministic
remove_element_from_diagram ea_diagram Takes an element's placement off a diagram, keeping the element and its connectors in the model Yes (diagram placement) Deterministic
replay_reporting_database ea_repository Rebuilds the reporting database, or the Parquet rows, from the last kept extract, with no EA connection No Deterministic
resize_diagram_objects ea_diagram Gives a selection one size: the most common, the largest, the smallest, or an explicit size Yes (diagram geometry) Deterministic
resolve_display_term ea_mdg Translates a technical stereotype, connector stereotype, tagged value or diagram type name into a business-readable term. On a miss it returns the technical name itself and says no match was found No Deterministic
resolve_skill_conflict ea_repository Applies your decision (keep local, use the published version, or use a merged text) to one locally edited skill file No (writes a file) Deterministic
select_element_in_browser ea_model Highlights an element in EA's Browser tree No (changes EA's highlight only) Deterministic
set_active_mdg ea_mdg Records a preferred technology id for the session. It enforces nothing No Deterministic
set_composite_diagram ea_model Sets or clears an element's child diagram, writing both halves in one call and reading them back Yes Deterministic
set_connector_tagged_value ea_model Creates or updates one tag on a connector Yes Deterministic
set_custom_style ea_diagram Changes the shape, opacity, text alignment, rotation, border style or card stack of one placed element on one diagram Yes (diagram presentation only) Deterministic
set_custom_styles_bulk ea_diagram The same for many placed elements on one diagram, in a single write Yes (diagram presentation only) Deterministic
set_diagram_display ea_diagram Sets display settings for a whole diagram. Settings you omit are left alone; false turns a setting off Yes (diagram presentation only) Deterministic
set_diagram_link ea_diagram Sets line style, color, width, label visibility and visibility for one connector on one diagram. Settings you omit are left alone Yes (diagram presentation only) Deterministic
set_diagram_links_bulk ea_diagram The same for many connectors on one diagram in one pass Yes (diagram presentation only) Deterministic
set_diagram_object ea_diagram Moves, resizes, re-orders or restyles one placed element in place. Only the fields you give change Yes (diagram placement) Deterministic
set_diagram_object_appearance ea_diagram Sets fill, border color and width, font color, name style, font and stacking number for one element on one diagram Yes (diagram presentation only) Deterministic
set_diagram_objects_appearance_bulk ea_diagram The same for many elements on one diagram in one pass Yes (diagram presentation only) Deterministic
set_diagram_objects_bulk ea_diagram The same for many placed elements in one call Yes (diagram placement) Deterministic
set_element_appearance ea_model Sets an element's model-wide default colors and border Yes Deterministic
set_element_icon ea_diagram Draws one placed element as a chosen icon on one diagram, adding the artwork to the model's image library if it is not already there Yes (image library and diagram presentation) Deterministic
set_element_image ea_diagram Draws one placed element as a picture from the library, on one diagram Yes (diagram presentation only) Deterministic
set_tagged_value ea_model Creates or updates one tag on an element; an existing tag of that name has its value replaced Yes Deterministic
start_reporting_refresh ea_repository Starts a refresh of a saved profile in the background and returns at once with a run id. For views in the EA repository's own database it regenerates the views; for a reporting database it runs the full build; for Parquet it rewrites the rows No. As for the build it runs Deterministic
summarize_connector_patterns ea_analyze Counts every distinct combination of source-element stereotype, connector stereotype and target-element stereotype across the repository, most frequent first. It also flags connector stereotype names that are used both bound to a language and ad hoc No Deterministic
summarize_observed_metaclasses ea_analyze For one stereotype, lists the EA element types that host it and flags it when there is more than one No Deterministic
summarize_stereotype_usage ea_analyze Counts elements by stereotype and EA element type. The resolved view also flags names used both bound to a language and ad hoc, and counts elements that carry more than one stereotype No Deterministic
summarize_tagged_value_usage ea_analyze For each tagged value name, reports how many elements have it, how many of those are actually filled in, how many distinct values appear, and the first 20 sample values. Optionally limited to one stereotype No Deterministic
trace_connectors ea_analyze Returns the connected sub-graph within a number of hops of one element: its elements and the connectors between them. Direction can be downstream (with the arrow), upstream (against it) or both, and can be limited to chosen connector types No Deterministic
traverse_element_subgraph ea_model Reads the neighborhood a few hops out from an element: the elements reached and the connectors between them No Deterministic
update_attribute ea_model Changes an attribute, identified by its GUID Yes Deterministic
update_connector ea_model Changes a connector's name, notes, stereotype, direction or type Yes Deterministic
update_diagram ea_diagram Changes a diagram's name, notes, author, version, parent element or raw settings Yes Deterministic
update_diagram_description ea_diagram Brings descriptions up to date in one of three modes: refresh (creates, extends or regenerates each diagram as it needs), replace or extend. Also writes the description a person decided when a refresh could not decide. A preview unless you say otherwise Yes (the diagram's notes and modified date) Deterministic
update_element ea_model Changes properties, tagged values and default appearance in one call Yes Deterministic
update_operation ea_model Changes an operation, identified by its GUID Yes Deterministic
update_package ea_model Changes a package's name, alias, notes, stereotype or version Yes Deterministic
verify_diagram ea_diagram Reloads a diagram, renders it, and returns the image plus every element's position, size, stacking number, fill and identity, every connector's decoded line style, color, width and visibility, and the canvas extents No Deterministic
write_mdg_xml ea_mdg Writes an MDG technology file from the description above. Writes the file only; does not install or register it No (writes a file) Deterministic