Skip to content

Agent entry

AgentFEM exposes one public workflow to people, scripts, IDEs, GUIs, and AI agents. An agent should construct or revise the readable case.py, use the structured CLI for operations, and accept results only through their explicit status and scientific evidence.

For a direct tool connection, install the official AgentFEM MCP companion. It exposes seven typed lifecycle operations to Codex, Claude, and other compatible hosts while leaving the model source, solver, and evidence in normal AgentFEM projects.

Machine-readable entrypoints

Resource Purpose
/llms.txt Short discovery document for language-model tools
/agentfem.json Versioned documentation and command manifest
installation in /agentfem.json Tested runtime and official/mainland-China environment commands
src/agentfem/knowledge/catalog.json Scientific cards, formulas, evidence, consumers, and maturity
agentfem doctor --json Environment capability check
agentfem workspace --json Runtime-independent project custody check
agentfem capabilities --json Public API, providers, maturity, and benchmark evidence
agentfem check --json Static project and upgrade check
agentfem run --json Addressable execution result
agentfem inspect --json Result and artifact discovery
agentfem telemetry status --json Exact privacy mode, queue and reviewed delivery routes
agentfem telemetry route auto|global|china --json Optional transport preference without location inference
agentfem inspect-abaqus model.inp --json Side-effect-free legacy-deck inventory
agentfem inspect-user-material material.for --json Fingerprinted UMAT/UHYPER source inventory and migration route
agentfem migrate-abaqus model.inp ./project --json Fail-closed Abaqus migration project
agentfem lower-abaqus ./project --reviewed-by NAME --unit-system SI --json Inactive reviewed native draft for the eligible subset

Safe operating sequence

discover → doctor → protect workspace → init/open → inspect project → edit case.py → check
         → run → inspect structured result → verify policy → publish or revise

If no environment exists, consume the installation contract from /agentfem.json or follow the installation guide. Do not infer that a PyPI wheel can provision DOLFINx/PETSc, and do not mix conda channels for the compiled numerical stack.

An agent must not infer scientific validity from a zero exit code. It should inspect convergence, requested outputs, quality policy, applicability limits, benchmark evidence, and any explicit failure record.

On WSL, an agent must not replace or unregister a distribution until agentfem workspace --json reports that project data is protected from distribution removal. Use agentfem workspace --protect; for the Complete Runtime, use its lifecycle scripts rather than reproducing destructive WSL commands.

For an Abaqus migration, inspect before creating a project. Preserve the complete source graph and review every issue in migration.json; never remove an element suffix, collapse Part/Instance scopes, or execute a generated material candidate merely because its syntax was recognized. When the native subset is eligible, record reviewer and unit interpretation, inspect the inactive draft and decision fingerprint, and activate separately. If a deck references user material, inspect its Fortran source separately; never interpret an adapter_candidate report as executable compatibility.

Start here