Skip to main content

PLAXIS · MCP

Drive PLAXIS 2D from any MCP client.

Geometry, staged construction, meshing, calculation and results — exposed as tools, over a hardened Windows-local stdio server.


release python mcp transport platform tools license

Quickstart · Tools · Clients · Security model · Architecture

mcp-name: io.github.yixuanzhong/plaxis-mcp


▸ v0.3 — set up once, launch from anywhere

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.


Quickstart

1 — Set up the machine, once.

plaxis-mcp.exe setup

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_target is derived from it.

2 — Run each role as its own process.

plaxis-mcp.exe serve --role input
plaxis-mcp.exe serve --role output

--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.

Getting the host

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 input
py -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.

Source / developer launch only — not a supported deployment path

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.

py -3.13 -m pip install .
$env:PLAXIS_ROLE = "input"
$env:PLAXIS_INPUT_HOST = "127.0.0.1"
$env:PLAXIS_INPUT_PORT = "10000"
$env:PLAXIS_BUNDLE_PYTHON = "C:\Path\To\PLAXIS\python.exe"
py -3.13 -I -u -m plaxis_mcp.server

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.


Tools

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.
  • Role status resources live at 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.
  • Every object in a result carries 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.
  • Results live on the Output server, which reads whatever the PLAXIS Output application has open. view_results(phase) on the Input server is what puts a calculated phase there.
  • When PLAXIS rejects a call, its own message travels beside ours in 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.

Clients

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.


Security model

  • Profiles are bound to one installation. 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.
  • Environment overrides are rejected, not merged: serve refuses to start when a PLAXIS_* endpoint variable is set.
  • Uncertified pairings fail closed. The Python match is exact — a 3.7-series interpreter at any other patch level is a different, uncertified ABI, so it is rejected rather than assumed compatible.
  • Ask before mutation. All clients should prompt before 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.
  • Mutation is not undoable. Absolute local and UNC .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.

Architecture

PLAXIS-MCP separates the MCP host from PLAXIS's vendor-managed Python runtime:

  MCP client  ──stdio──▶  host (CPython 3.13, mcp 1.26.0)
                              │
                              ├─ private local pipe
                              ▼
                          role-pinned worker (PLAXIS bundled Python)
                              │
                              ▼
                          PLAXIS Remote Scripting @ 127.0.0.1
  • Client traffic is always MCP over stdio; normal logs and diagnostics go to stderr.
  • PLAXIS-MCP never installs packages into, upgrades, or redistributes the PLAXIS Python bundle.

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.

Requirements

  • Windows, with a supported local PLAXIS 2D installation and Remote Scripting enabled.
  • CPython 3.13 for the MCP host. Supported host range: >=3.13,<3.14.
  • One PLAXIS Input and/or Output server listening only on loopback — defaults Input 127.0.0.1:10000, Output 127.0.0.1:10001.
  • A selected, certified PLAXIS bundled-Python profile. Do not install plxscripting into the MCP host environment.
Historical PLAXIS scripting paths — worker-only, never on the host PYTHONPATH
C:\ProgramData\Seequent\PLAXIS Python Distribution V2\python\Lib\site-packages
C:\ProgramData\Bentley\Geotechnical\PLAXIS Python Distribution V2\python\Lib\site-packages

Docker, 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.


Development & verification

# unit suite, from the CPython 3.13 host environment
py -3.13 -m unittest discover -s tests

# inspect the split host/worker configuration without starting PLAXIS
py -3.13 scripts/smoke_test.py

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.


References

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plaxis_mcp-0.3.3.tar.gz (110.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plaxis_mcp-0.3.3-py3-none-any.whl (76.3 kB view details)

Uploaded Python 3

File details

Details for the file plaxis_mcp-0.3.3.tar.gz.

File metadata

  • Download URL: plaxis_mcp-0.3.3.tar.gz
  • Upload date:
  • Size: 110.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for plaxis_mcp-0.3.3.tar.gz
Algorithm Hash digest
SHA256 24d14f65da34324cb7b999dda785e905c586742d8eb7be2c0beb9cc41fc4a41f
MD5 edee38ac2e9c1d44876a5121eb6abc66
BLAKE2b-256 acecae6cad1299ef97898c709eb9bc620a973dad736c5e04a6619261c121395e

See more details on using hashes here.

Provenance

The following attestation bundles were made for plaxis_mcp-0.3.3.tar.gz:

Publisher: workflow.yml on yixuanzhong/PLAXIS-MCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file plaxis_mcp-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: plaxis_mcp-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 76.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for plaxis_mcp-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5c92c10079610321873d30452e62d5f7c337e5dc9de7c7905c1dd07361aa762b
MD5 fe3fb8ab0b359db6275d3272707ec079
BLAKE2b-256 e037174133c54cad6e8c19eddbe07fe0233fa121eb82a40abf2211c01a4561ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for plaxis_mcp-0.3.3-py3-none-any.whl:

Publisher: workflow.yml on yixuanzhong/PLAXIS-MCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.3.5

2 files

0.3.4

2 files

This release

0.3.3 This release

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page