run_simulation

Run a CFD, heat-transfer or conjugate thermal (CHT) simulation to predict temperatures, pressure drop, flow and forces on a meshed design.

Scope: simulations:write. Catalogue annotation: Writes / prepares / submits work. Additional ownership and role checks may apply.

REST: POST /v1/simulations.

Arguments

Field

Type / accepted values

Required

Default

Constraints / meaning

project_id

string (uuid) or null

No

null

mesh_artifact_id

string

Yes

Omitted

minLength: 1; maxLength: 128; pattern: "^[A-Za-z0-9_-]+$"

restart_artifact_id

string or null

No

null

minLength: 1; maxLength: 128; pattern: "^[A-Za-z0-9_-]+$"

mesh_unit_conversion

MeshUnitConversion or null

No

null

config

MCP_run_simulation_FluxCoreConfig

No

Omitted

decision_context

MCP_run_simulation_DecisionContext

No

Omitted

convergence_criteria

MCP_run_simulation_ConvergenceCriteria or null

No

null

How to judge this run converged when it finishes; omit for the standard test.

idempotency_key

string

Yes

Omitted

minLength: 1; maxLength: 128; pattern: "^[A-Za-z0-9_.:-]+$"; Use a fresh unique key for each newly requested job, even with identical inputs or a matching completed job. Reuse unchanged only for retries/resuming that same intended job. Never replace it to retry an uncertain submission.

notify_url

string or null

No

null

maxLength: 2048; Optional public HTTPS URL that receives a signed notification when the job finishes, so you need not poll.

Calling the tool

Use tools/call with this tool’s exact name and an arguments object matching the fields above. Get the complete live schema before supplying advanced controls:

{
  "name": "get_tool_schema",
  "arguments": {
    "name": "run_simulation",
    "include_definitions": false
  }
}

Result and continuation

Inspect isError and structuredContent. Keep returned job, operation and artifact IDs. A pending operation_id is followed with get_operation; a compute job is followed with get_job. A wait timeout does not cancel work. Follow returned polling intervals and retain the same idempotency key when reconciling the same submission.

See agent workflow, jobs and operations, uploads, results and error recovery for the applicable lifecycle. MCP annotations describe tool behaviour; they are not blanket permission to run paid work or change account state.