Skip to main content

MCP server for ELF600 electromagnetic field analysis: 26 curated topics + raw access to 1141 bundled help files (search/index/get) — .mai/.mei/.meg formats, eddy current (MAB/MAT/MBB), AC SOL MOMC, IPM motor workflow.

Project description

mcp-server-elf

PyPI License: BSD-3-Clause Python: 3.10+

MCP server providing ELF600 electromagnetic field analysis documentation — file formats, solver options, element types, and workflow recipes for the ELF600 BEM-based electromagnetic analysis suite (MAGIC magnetostatic, ELFIN electrostatic, BEAM particle tracking).

This server does not execute ELF600 simulations — it provides curated documentation that AI coding assistants (Claude Code, Cursor, etc.) can consult while authoring .mai/.mei/.meg input files for ELF.


Features

4 tools providing both curated topic-based docs and raw access to all 1141 ELF600 help HTM files:

Tool Purpose
elf_usage(topic) 26 curated topics — high-level recipes
elf_help_index(prefix) List all 1141 bundled help files (filterable by directory)
elf_help_search(query, top_k, prefix) Substring search across all help text (AND multi-keyword)
elf_help_get(path, max_chars) Get full extracted text of a specific HTM

The bundled help_dump.json is generated from C:/ELF600/help/ Shift_JIS HTM files via scripts/crawl_help.py (1141 files, ~1.18M characters, decoded + HTML-stripped).

Curated topics (elf_usage)

Returns documentation on:

  • File formats: .mai (analysis input), .mei (mesh script), .meg (compiled mesh)
  • Solvers: MAGIC (magnetostatic, transient, AC), ELFIN (electrostatic), BEAM (particle tracking)
  • Eddy current: MAB / MAT / MBB elements, time-stepping, sinusoidal AC (SOL MOMC)
  • Element types: full catalog with DOF counts and symmetry restrictions (3D / 2D / Axisym)
  • B-H curves: anisotropy (HBA1/HBA2), recoil, extrapolation
  • IPM motor workflow: Ld/Lq calculation
  • Inductance: Lsc (JIS) and Ll (IEEJ) with 6 samples
  • Magnetization / demagnetization (MAGNE2)
  • Convergence troubleshooting, error codes (160+ ELF-Q/E/W codes)
  • Force methods: FORC vs FORT vs FIXB
  • Tools: IEmesh, Wmap3, MagFilter2, MaiEditor3, ELF/Bench

Available topics:

all, overview, mai_format, mei_format, meg_format,
magic, elfin, beam, element_types, bh_curves,
sol_commands, mei_commands, ipm_motor, inductance,
magnetization, examples, meg_export, treasure_box,
sinusoidal, anisotropy, sted, meshing, convergence,
force_methods, errors, iemesh, tools

Installation

pip install mcp-server-elf

Verify:

mcp-server-elf --selftest

Usage

Claude Code

claude mcp add elf "C:/Program Files/Python312/Scripts/mcp-server-elf.exe"

(Adjust path for your Python install. On Linux/macOS, the script is typically ~/.local/bin/mcp-server-elf or similar.)

Cursor / Other MCP clients

Add to your MCP config:

{
  "mcpServers": {
    "elf": {
      "command": "mcp-server-elf"
    }
  }
}

Self-test

mcp-server-elf --selftest

Iterates through all 26 topics and asserts non-empty documentation.


What is ELF600?

ELF600 is a commercial BEM (Boundary Element Method) electromagnetic analysis suite distributed by Science Solutions International Laboratory (https://www.science-solutions.jp/elf/).

Module Purpose
MAGIC Magnetostatic field (static, transient, AC). Eddy current via MAB/MAT/MBB.
ELFIN Electrostatic field analysis (D-E curves)
BEAM Charged particle beam tracking

Workflow:

.mei (mesh script) --> IEmesh --> .meg (compiled mesh)
.mai (analysis) + .meg --> MAGIC/ELFIN/BEAM --> .mag/.mao results

Why this server?

LLM coding agents authoring ELF input files (.mai/.mei) need access to:

  • The ~60k character ELF reference manual content,
  • Element naming conventions (T/K/R symmetry × element family),
  • SOL block recipes (MOME / MOMC / FIEL / FORC / NONL),
  • Frequency-sweep AC analysis structure,
  • Common error code interpretation,

without polluting context with the entire vendor PDF. This MCP server returns just the relevant topical chunk on demand.


License

BSD-3-Clause. See LICENSE.

ELF600 itself is a commercial product of Science Solutions International Laboratory and is not redistributed by this package — only documentation references.


Author

Kengo Sugahara, Kindai University (ksugahar@ele.kindai.ac.jp)

Project details


Download files

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

Source Distribution

mcp_server_elf-1.28.0.tar.gz (500.9 kB view details)

Uploaded Source

Built Distribution

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

mcp_server_elf-1.28.0-py3-none-any.whl (509.9 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_elf-1.28.0.tar.gz.

File metadata

  • Download URL: mcp_server_elf-1.28.0.tar.gz
  • Upload date:
  • Size: 500.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_server_elf-1.28.0.tar.gz
Algorithm Hash digest
SHA256 1724e4c3232392b1c1126b6a71794409eea11a7b04a5aa57d22b7b9b5e245de6
MD5 28c458d82db81dc8fcccdbc4eafc9614
BLAKE2b-256 432b561a1cae740f20473914ea938bcef97a85c5997729fa5568c6ac795ac424

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_elf-1.28.0.tar.gz:

Publisher: publish.yml on ksugahar/mcp-server-elf

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

File details

Details for the file mcp_server_elf-1.28.0-py3-none-any.whl.

File metadata

  • Download URL: mcp_server_elf-1.28.0-py3-none-any.whl
  • Upload date:
  • Size: 509.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_server_elf-1.28.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2079be9270c8990f85a08e431566546e11d4d18723b73e15a9bdaac7d6c8d4d7
MD5 ffd8ccc1d99a0903e31ebd01bdbdbdd2
BLAKE2b-256 fd4d01a7b5a3cab723bec0a0cfad0b97bb08c9661ad89367bb6bcbf7f4037933

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_elf-1.28.0-py3-none-any.whl:

Publisher: publish.yml on ksugahar/mcp-server-elf

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page