The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the PLAXIS listing page.
Geometry, staged construction, meshing, calculation and results — exposed as tools, over a hardened Windows-local stdio server.
Quickstart · Tools · Clients · Security model · Architecture
mcp-name: io.github.yixuanzhong/plaxis-mcp
| One-shot machine setup | plaxis-mcp setup discovers the PLAXIS installation, writes both role profiles, and stores each role password in Windows Credential Manager — with hidden prompts, no password argument. |
| Shared profile store | Every client on the machine reads the same profiles. Claude Code, Codex, Cursor and VS Code all bind to one installation and one credential set. |
serve --role | No per-client config surgery. --role input / --role output resolves its own profile. |
| Mode-aware operations | generate_mesh, create_phase and calculate enter the PLAXIS mode they need, so a workflow never has to interleave set_mode calls. |
| Listed on the MCP Registry | Published as io.github.yixuanzhong/plaxis-mcp, installable with uvx. |
Client-neutral by design: Codex, Claude Code, Cursor, VS Code/Copilot and any other conforming local stdio MCP client connect to the same unprefixed server tools.
1 — Set up the machine, once.
Profiles land in %LOCALAPPDATA%\Caros\PLAXIS-MCP\profiles (override with --profile-dir).
Add --skip-credentials to generate profiles now and store passwords later with
plaxis-mcp.exe credentials set --profile <profile.toml>.
The directory name is historical — it is where the first supported installer wrote — and is kept because
credential_targetis derived from it.
2 — Run each role as its own process.
--config <profile.toml> names a profile explicitly and is equivalent. Either way serve
takes every endpoint setting from the profile and the password from Windows Credential
Manager, and it fails to start if any PLAXIS_* endpoint environment override is
present — so a client cannot silently redirect an endpoint or inject a password.
3 — Point a client at it. See Clients; the host never connects at startup,
so call the connect tool once PLAXIS is running.
| Distribution | Command | Assurances |
|---|---|---|
| Signed Windows package | plaxis-mcp.exe | Authenticode-signed, hash-manifested, installer-verified. The supported production deployment. |
| PyPI | uvx plaxis-mcp serve --role inputpy -3.13 -m pip install plaxis-mcp | Ordinary Python source distribution. No code signature, no artifact manifest. |
Both expose the same setup, serve, credentials and profiles commands and enforce the
same profile binding and environment-override rejection — so PyPI is not a weaker runtime
posture. It simply carries no supply-chain attestation of its own beyond PyPI's, and it is not
what an organization requiring signed binaries should deploy.
Do not install plxscripting into the host environment under either.
A clean CPython 3.13 environment can run the module directly with endpoint environment variables. This path carries the password in the environment and performs no installation binding.
For Output, set PLAXIS_ROLE=output and use the PLAXIS_OUTPUT_* variables. Role-specific
variables take precedence over the deprecated generic PLAXIS_HOST, PLAXIS_PORT and
PLAXIS_PASSWORD fallback. The server accepts stdio only — do not set a non-stdio
PLAXIS_MCP_TRANSPORT.
Each process has one immutable role. A client registers Input and Output as separate MCP servers when it needs both.
| Role | Endpoint | Tools |
|---|---|---|
| Both | — | connect · disconnect · connection_status · list_members · inspect · project_info · list_phases · list_materials |
| Input | 127.0.0.1:10000 | list_objects · model_state · set_property · call_method · new_project · open_project · close_project · recover_project · save_project · create_phase · set_current_phase · set_phase_property · activate · deactivate · calculate · view_results · set_mode · generate_mesh · create_point · create_line · create_polygon · create_borehole · create_soillayer · create_material · assign_material · create_structural_element |
| Output | 127.0.0.1:10001 | list_result_types · get_results · get_single_result |
34 Input tools · 11 Output tools.
connect() takes no endpoint or credential arguments. It uses only the pinned role
configuration, so an agent cannot redirect a stored password to an arbitrary host.plaxis://input/status and plaxis://output/status.get_results(phase, result_type_path, fem_type="node", offset=0, limit=200) paginates
losslessly. limit is 1–5,000; responses report count, offset, limit,
returned_count, has_more, next_offset and results.path — the exact string to pass back to any reference
parameter. list_objects(kind) lists a whole kind that way, with a geometry summary
(coordinates, or a parsed bounds for objects that report a bounding box).model_state() reports mesh status, the phase table and unassigned materials before a
calculate is attempted. It separates blocking (a fault in this model) from unknown (a
check that could not run here) and caveats (something PLAXIS does not expose at all — on
2D V22, whether the mesh still matches the geometry), so an empty blocking is never
mistaken for a clean bill of health.view_results(phase) on the Input server is what puts a calculated phase there.plaxis_message
(sanitised: no filesystem paths, no frames, capped with the truncation flagged out of band).
A failing calculate also carries a per-phase table in details.All shipped examples are secret-free and use two server entries, one per role. Replace the
command with wherever plaxis-mcp.exe lives, or with uvx plaxis-mcp for a PyPI install.
Nothing else needs editing — --role finds the shared profiles by itself.
| Client | Example | Credentials & approvals |
|---|---|---|
| Codex | codex-config.toml | env_vars forwards the locally stored password; default_tools_approval_mode = "writes". |
| Claude Code | claude-code-mcp.json | Expand only a user-level environment variable in .mcp.json; retain server trust and tool approval prompts. |
| Cursor | cursor-mcp.json | Role password in the user environment at launch; keep Auto-run off. |
| VS Code / Copilot | vscode-mcp.json | Use a password inputs entry — VS Code stores it securely for reuse. Keep Default Approvals, not Bypass or Autopilot. |
The generic mcp-client-config.json is a minimal
mcpServers example for clients using that conventional JSON shape.
Never add a PLAXIS password to version control, command-line arguments, logs, or a profile file.
credential_target is derived from
installation_root, and worker_python must be an interpreter that discovery links to
that same root. Editing any of the three by hand makes the profile fail to load. This is
what stops a profile from handing a stored PLAXIS password to an arbitrary executable.serve refuses to start when a
PLAXIS_* endpoint variable is set.call_method and project/file
mutators. Do not set an Always Allow-style rule for call_method, open_project or
save_project: client approval is generally tool-wide, not argument-scoped..p2dx paths reachable by PLAXIS are
allowed only after user approval. Client approvals and client-side checkpointing cannot
restore in-memory PLAXIS state — use disposable projects and backups for all mutation
testing.PLAXIS-MCP separates the MCP host from PLAXIS's vendor-managed Python runtime:
The split is required because the MCP host needs a current Python runtime while PLAXIS ships version-specific scripting environments.
| PLAXIS generation | Bundled Python | Runtime profile | Release status |
|---|---|---|---|
| PLAXIS 2024.2 and newer | 3.12.3 | current-312 | Enable after live certification |
| PLAXIS CONNECT Edition V22 → early 2024 | 3.8.10 | legacy-38 | Initial production target |
| PLAXIS CONNECT Edition V20 / V21 | 3.7.4 | legacy-37 | Enable after live and security certification |
V20 and V21 share the legacy profile: their end-of-life Python is isolated inside the loopback worker and requires organizational security acceptance.
>=3.13,<3.14.127.0.0.1:10000, Output 127.0.0.1:10001.plxscripting into the
MCP host environment.PYTHONPATHDocker, WSL, remote MCP transports, and PLAXIS bundles copied into a Python environment are not supported deployment paths for v0.3. The former Docker artifacts were removed intentionally.
Before a release: verify the host wheel/installer in a clean environment, confirm pip check,
scan the artifact for vendor files, validate the MCP contract at protocol 2025-03-26, and
complete live certification with a disposable calculated project for every enabled PLAXIS
profile.
MCP Python SDK · Codex · Claude Code · Cursor · VS Code
MIT licensed. PLAXIS is a trademark of Seequent and related companies.
This independent integration is not affiliated with, endorsed by, or sponsored by Seequent or Bentley Systems.