Create a new AFSIM scenario in memory.

Parameters

name: Unique name for the scenario. description: Optional human-readable description. duration_s: Simulation duration in seconds (default 3600). time_step_s: Simulation time step in seconds (default 1.0).

Returns

JSON with scenario_id, name, and metadata.

Load a scenario from disk.

Parameters

file_path: Path to the scenario file. format: 'afsim' for .afsim files (default), 'json' for JSON files.

Returns

JSON with scenario_id and metadata.

Save a scenario to disk.

Parameters

scenario_id: UUID of the scenario to save. file_path: Destination path. Defaults to scenarios/.afsim (or .json). format: 'afsim' (default) or 'json'.

Returns

JSON with the saved file path.

Validate a scenario and return errors/warnings.

Parameters

scenario_id: UUID of the scenario to validate.

Returns

JSON with 'valid', 'errors', and 'warnings' lists.

List all in-memory scenarios.

Returns

JSON array of scenario summaries.

List scenario files (.afsim and .json) in the scenarios directory.

Returns

JSON array of file paths.

Remove a scenario from memory (does not delete files on disk).

Parameters

scenario_id: UUID of the scenario to remove.

Returns

JSON with 'removed' boolean.

Get the AFSIM text representation of a scenario.

Parameters

scenario_id: UUID of the scenario.

Returns

JSON with 'name' and 'content' (AFSIM scenario text).

Add a new platform (entity) to a scenario.

Parameters

scenario_id: UUID of the target scenario. name: Unique name for the platform within the scenario. platform_type: AFSIM platform type (e.g. 'wsf_air_vehicle', 'wsf_ground_vehicle'). latitude, longitude: Initial position in decimal degrees. altitude_m: Initial altitude in metres.

Returns

JSON with platform metadata.

Remove a platform from a scenario.

Parameters

scenario_id: UUID of the target scenario. platform_name: Name of the platform to remove.

Returns

JSON with 'removed' boolean.

Modify an existing platform's position or type.

Parameters

scenario_id: UUID of the target scenario. platform_name: Name of the platform to modify. latitude, longitude, altitude_m: New position values (omit to keep current). platform_type: New platform type string (omit to keep current).

Returns

JSON with updated platform metadata.

List all platforms in a scenario.

Parameters

scenario_id: UUID of the target scenario.

Returns

JSON array of platform summaries.

Add a mover component to a platform.

Parameters

scenario_id: UUID of the target scenario. platform_name: Name of the target platform. mover_type: AFSIM mover type (e.g. 'wsf_route_mover', 'wsf_air_mover'). mover_name: Optional name for the mover component.

Returns

JSON with component metadata.

Add a sensor component to a platform.

Parameters

scenario_id: UUID of the target scenario. platform_name: Name of the target platform. sensor_type: AFSIM sensor type (e.g. 'wsf_radar_sensor', 'wsf_eo_sensor'). sensor_name: Optional name for the sensor component.

Returns

JSON with component metadata.

Add a weapon component to a platform.

Parameters

scenario_id: UUID of the target scenario. platform_name: Name of the target platform. weapon_type: AFSIM weapon type (e.g. 'wsf_missile', 'wsf_bomb'). weapon_name: Optional name for the weapon component.

Returns

JSON with component metadata.

Remove a component from a platform.

Parameters

scenario_id: UUID of the target scenario. platform_name: Name of the target platform. component_name: Name of the component to remove.

Returns

JSON with 'removed' boolean.

List all components on a platform.

Parameters

scenario_id: UUID of the target scenario. platform_name: Name of the target platform.

Returns

JSON array of component summaries.

Run an AFSIM simulation for the specified scenario.

If no AFSIM binary is configured (or dry_run is True), the simulation is recorded as completed immediately without executing AFSIM.

Parameters

scenario_id: UUID of the scenario to simulate. dry_run: If True, skip actual AFSIM execution (useful for testing).

Returns

JSON with run_id, status, and other run metadata.

Stop a running simulation.

Parameters

run_id: UUID of the simulation run to stop.

Returns

JSON with updated run status.

Query the current status of a simulation run.

Parameters

run_id: UUID of the simulation run.

Returns

JSON with status, times, PID, output directory, etc.

List all known simulation runs and their statuses.

Returns

JSON array of run summaries.

Configure the path to the AFSIM simulation binary.

Parameters

binary_path: Absolute path to the AFSIM executable.

Returns

JSON confirmation.

List simulation result files.

Parameters

run_id: Filter to a specific run's output directory (optional). directory: Directory to scan (overrides default output dir). formats: Comma-separated list of extensions to include (e.g. '.aer,.csv').

Returns

JSON array of result file metadata.

Read and query a CSV result file.

Parameters

file_path: Path to the CSV file. columns: Comma-separated column names to include (all if empty). max_rows: Maximum rows to return (default 1000).

Returns

JSON with columns, row_count, and rows.

Read an AFSIM .evt event file.

Parameters

file_path: Path to the .evt file. max_lines: Maximum lines to return (default 500).

Returns

JSON with line_count and lines array.

Read an AFSIM .aer archive/result file.

Parameters

file_path: Path to the .aer file. max_lines: Maximum lines to return (default 500).

Returns

JSON with line_count and lines array.

Convert a result file (.csv, .evt, .aer) to JSON format.

Parameters

file_path: Path to the source result file. output_path: Destination JSON path (defaults to same name with .json extension).

Returns

JSON with the output file path.

Summarise simulation results in a directory.

Parameters

directory: Directory to summarise (defaults to simulation output dir).

Returns

JSON with total_files, by_format counts, and total_size_bytes.

Set the AFSIM installation root directory.

Parameters

path: Path to AFSIM_HOME (the directory containing bin/, data/, etc.).

Returns

JSON confirmation with detected binaries.

Auto-detect AFSIM installation from environment and file system.

Returns

JSON with afsim_home, binary paths, and all_found flag.

Override the binary path for a specific AFSIM tool.

Parameters

tool: Tool identifier: 'wizard', 'mission', 'warlock', or 'mystic'. path: Absolute path to the tool binary.

Returns

JSON confirmation.

Launch the AFSIM Wizard (GUI scenario builder).

Parameters

scenario_file: Optional path to open in Wizard.

Returns

JSON with success flag and PID (if launched).

Launch the AFSIM Mission Planner.

Parameters

scenario_file: Optional path to open in Mission Planner.

Returns

JSON with success flag and PID.

Run the AFSIM Warlock batch simulation engine.

Parameters

scenario_file: Path to the AFSIM scenario file. output_dir: Directory for output files (default current dir).

Returns

JSON with success flag, returncode, stdout/stderr snippets.

Launch the AFSIM Mystic post-processor.

Parameters

results_dir: Directory containing simulation results to analyse.

Returns

JSON with success flag and PID.

Generate an AFSIM scenario from a natural language description.

The generator uses keyword matching and heuristics to parse the prompt and build a scenario with platforms, movers, sensors, and weapons.

Examples: "Create a scenario with 2 fighters and a ship over 2 hours" "Simulate 3 UAVs with radar sensors patrolling for 30 minutes" "Air defense scenario: 1 SAM site and 4 attack aircraft, 1 hour"

Parameters

prompt: Natural language description of the desired scenario.

Returns

JSON with scenario_id, name, platform list, warnings, and AFSIM preview.

Apply a natural language refinement to an existing scenario.

Supports:

• Adding platforms: "add 2 more fighters"

• Changing duration: "extend to 3 hours"

Parameters

scenario_id: UUID of the scenario to refine. refinement_prompt: Natural language description of the changes to make.

Returns

JSON with changes applied and updated platform count.