SimConnect MCP docs

MCP Tools — SimConnect Mode

All 70 MCP tools listed here are available when the server runs with MCP_MODE=simconnect (and, on Windows, with MCP_MODE=both, alongside the 15 docs tools — 85 in all). This mode provides live simulator data via the SimConnect SDK, and AI traffic under our control.

Both mode: with MCP_MODE=both on Windows, the server registers these 70 tools alongside the 15 docs-mode tools — 85 tools in total — provided SimConnect opens at startup (10-second timeout). If the simulator cannot be reached, or on non-Windows platforms, both mode serves the 15 docs tools only; simconnect_ready in the /health response reports which case applies.

Requirements: Windows only. Microsoft Flight Simulator 2020 or 2024 must be running with SimConnect enabled before issuing any read or transmit calls. The get_sim_state tool is safe to call at any time regardless of connection state.

Tools are called over the Model Context Protocol using JSON-RPC 2.0 with the tools/call method. Error responses are returned as text content (not JSON-RPC errors) with a prefix token followed by a colon and a human-readable message.

Tool Overview

get_simvar_value

Read a single live simulation variable from the running simulator.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_simvar_value",
    "arguments": {
      "name": "PLANE ALTITUDE",
      "unit": "feet"
    }
  }
}

Example response (connected)

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"name\":\"PLANE ALTITUDE\",\"value\":5280.0,\"unit\":\"feet\",\"sim_time\":3742.5}"
      }
    ]
  }
}

Example response (disconnected)

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "BRIDGE_DISCONNECTED: no active simulator connection"
      }
    ],
    "isError": true
  }
}

Error codes

• BRIDGE_DISCONNECTED: The SimConnect bridge is not connected to the simulator. Start the simulator and ensure SimConnect is enabled.
• INVALID_ARGUMENT: name or unit was not provided or is empty.
• UNKNOWN_VARIABLE: The variable name or unit is not recognised by SimConnect. Check the name against the SimConnect SDK reference.
• INTERNAL_ERROR: Unexpected bridge or SimConnect failure.

get_simvar_values

Read up to 20 live simulation variables in a single call. Per-item failures are embedded in the response array and do not abort the batch.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

An array of result objects. Each object has:

Example request

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "get_simvar_values",
    "arguments": {
      "vars": [
        { "name": "PLANE ALTITUDE", "unit": "feet" },
        { "name": "AIRSPEED INDICATED", "unit": "knots" }
      ]
    }
  }
}

Example response (connected)

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "[{\"name\":\"PLANE ALTITUDE\",\"value\":5280.0,\"unit\":\"feet\",\"sim_time\":3742.5},{\"name\":\"AIRSPEED INDICATED\",\"value\":142.3,\"unit\":\"knots\",\"sim_time\":3742.5}]"
      }
    ]
  }
}

Error codes

• BRIDGE_DISCONNECTED: The SimConnect bridge is not connected to the simulator.
• INVALID_ARGUMENT: vars was not provided, is empty, exceeds 20 items, or contains an item missing name or unit.
• UNKNOWN_VARIABLE: One or more variable names or units in the batch are not recognised by SimConnect.
• INTERNAL_ERROR: Unexpected bridge or SimConnect failure.

transmit_event

Transmit a named SimConnect client event to the running simulator.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "transmit_event",
    "arguments": {
      "name": "LANDING_LIGHTS_TOGGLE"
    }
  }
}

Example response (connected)

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"event\":\"LANDING_LIGHTS_TOGGLE\",\"success\":true,\"value\":0}"
      }
    ]
  }
}

Example response (disconnected)

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "BRIDGE_DISCONNECTED: no active simulator connection"
      }
    ],
    "isError": true
  }
}

Error codes

• BRIDGE_DISCONNECTED: The SimConnect bridge is not connected to the simulator.
• INVALID_ARGUMENT: name was not provided or is empty, or value is not an integer in the range [0, 4294967295].
• INTERNAL_ERROR: Unexpected bridge or SimConnect failure.

get_sim_state

Return a snapshot of current simulator connection state and flight status. This tool never returns an error — it returns {"connected": false} when the bridge is not connected, allowing clients to safely poll at any connection state.

Requirements: Windows. The simulator does not need to be running.

Parameters: None.

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "tools/call",
  "params": {
    "name": "get_sim_state",
    "arguments": {}
  }
}

Example response (connected)

{
  "jsonrpc": "2.0",
  "id": 4,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"connected\":true,\"current_flight\":\"LAST.FLT\",\"paused\":false,\"sim_time\":3742.5,\"simulator_version\":\"11.0.282174.0\"}"
      }
    ]
  }
}

Example response (disconnected)

{
  "jsonrpc": "2.0",
  "id": 4,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"connected\":false}"
      }
    ],
    "isError": false
  }
}

Error codes: None. This tool always succeeds.

get_fuel_state

The user aircraft’s fuel: total quantity and capacity, percent full and weight, with the center, left main and right main tanks. Tanks the aircraft does not have (zero capacity) are left out. It reads all nine SimVars in one request.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters: none.

Returns

Example response (an A320 with 50 % of its fuel, none in the center tank)

{
  "total_quantity_gal": 3200, "total_capacity_gal": 6400, "total_percent_full": 50,
  "total_weight_lbs": 21440, "total_weight_kg": 9725,
  "tanks": [
    { "name": "Center", "quantity_gal": 0, "capacity_gal": 2200, "percent_full": 0 },
    { "name": "Left Main", "quantity_gal": 1600, "capacity_gal": 1800, "percent_full": 88.9 },
    { "name": "Right Main", "quantity_gal": 1600, "capacity_gal": 1800, "percent_full": 88.9 }
  ]
}

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• INTERNAL_ERROR: The simulator refused a fuel SimVar.

get_aircraft_systems

The user aircraft’s systems, read through its systems profile (the library’s pkg/systems). The profile is the standard SimVars, the library’s shipped profile for the model on top (the Fenix A320 family reads power, radios, chocks and GPU from its own L:vars and tablet), then the local override files from SIMCONNECT_AIRCRAFT_PROFILES on top of that. The model is matched by its package (found from the aircraft the sim loaded, with pkg/addons), its title or its ATC type.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters: none.

Returns

Example response (a cold and dark Fenix A319, shortened)

{
  "aircraft": { "title": "FenixA319 CFM WF HD", "atc_type": "", "package": "fnx-aircraft-319-321", "package_source": "Community" },
  "profile": { "name": "Fenix A320 family" },
  "power": { "battery": false, "powered": false, "bus_volts": 27.5, "external_available": true, "external_on": false },
  "radios": { "com1": { "working": false, "active_mhz": 0, "standby_mhz": 0 } },
  "transponder": { "state": "off", "squawk": "2000" },
  "doors": [ { "control": "door0", "name": "L1", "open": false }, { "control": "door4", "name": "FWD cargo", "open": false } ],
  "ground": { "chocks": true, "has_chocks": true, "gpu": true, "has_gpu": true, "pushback_available": true },
  "can": ["baggage", "cabinCall", "chocks", "door0", "gpu", "jetway", "parkingBrake", "pushback", "seatbelts"]
}

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• TIMEOUT: The simulator did not answer in 5 s.

set_aircraft_control

Operate one of the user aircraft’s controls the way its profile says: the standard key events by default, the model’s own variables or tablet where it has them (the Fenix’s chocks and GPU go through its EFB). A toggling event is sent only when the state differs from the one asked for.

Parameters

Returns control, requested (1 on, 0 off; no_smoking 0–2) and state_now, the value read right after the command (doors and tablet controls take a few seconds); cabin_call returns pressed.

Error codes

• INVALID_ARGUMENT: Unknown control or state; the message lists the aircraft’s doors.
• NOT_APPLICABLE: The aircraft’s profile gives no way to operate it (get_aircraft_systems lists can).
• BRIDGE_DISCONNECTED, TIMEOUT.

request_ground_service

Ask for one of the simulator’s own ground services for the user aircraft, by the MSFS key events (TOGGLE_JETWAY, TOGGLE_RAMPTRUCK, REQUEST_LUGGAGE, REQUEST_CATERING, REQUEST_POWER_SUPPLY, REQUEST_FUEL_KEY, TOGGLE_PUSHBACK) or the model’s own way where its profile gives one. The jetway, stairs and pushback toggle: asking again sends them away. The simulator decides whether the service can come where the aircraft is.

Parameters

Returns service and requested: true.

Error codes: INVALID_ARGUMENT, NOT_APPLICABLE, BRIDGE_DISCONNECTED, TIMEOUT.

set_radio

Set the user aircraft’s radios with the library’s pkg/avionics. The aircraft must be powered: a dark radio ignores it. On the Fenix the swap presses its RMP transfer key (L:S_PED_RMP1_XFER), because the stock swap event does not reach its RMP. get_aircraft_systems reads the result back.

Parameters

Returns the request and sent: true.

Error codes

• INVALID_ARGUMENT: A radio other than 1–3, a frequency out of the band, or a squawk that is not four digits 0–7. Nothing is sent.
• BRIDGE_DISCONNECTED, TIMEOUT.

set_atc_callsign

Set the call sign the simulator’s ATC uses for the user aircraft: ATC AIRLINE (the airline’s call sign as said) and ATC FLIGHT NUMBER. Either may be left out to keep it. The registration (ATC ID) is not changed.

Parameters

At least one is required. Returns set: true and the values set.

Error codes: INVALID_ARGUMENT, BRIDGE_DISCONNECTED.

list_addons

What is installed in Microsoft Flight Simulator on this machine, with the library’s pkg/addons. It reads files only: the UserCfg.opt of MSFS 2024 or 2020 (Steam or Microsoft Store) gives the packages folder, then each package’s manifest.json. Streamed packages have no manifest; when a folder name reads as an airport (fs20-orbx-airport-lkpr-prague), its ICAO and publisher are given. A streamed folder shows that the sim knows the package, not that it is owned. The scan is cached for 5 minutes.

Parameters

Returns

Error codes

• NOT_FOUND: No MSFS 2024 or 2020 installation found.
• SIM_ERROR: The packages folder could not be read.

get_gsx_state

GSX Pro’s state for the user aircraft, read from the L:vars GSX’s manual documents (the library’s pkg/gsx). Without GSX every value is 0 and running is false.

Parameters: none.

Returns

Error codes: BRIDGE_DISCONNECTED, TIMEOUT.

set_lvar

Writes an L:var (local variable) on the user aircraft as a number (the library’s pkg/lvars). It can be an aircraft’s own switch or setting, a GSX L:var that add-ons may write, or a new variable of your own; a new name creates it, and every other client can then read it. Read it back with get_simvar_value (name: "L:...", unit: "number"). What a write does depends on the aircraft: some switches follow their L:var, others only their own events. Up to 64 different names per simulator connection.

Returns name (with its L:), value and set: true.

Error codes: INVALID_ARGUMENT (not an L:var name, or no number), BRIDGE_DISCONNECTED, SIM_ERROR (more than 64 names).

set_simvar_value

Write a numeric simulation variable to the user aircraft. Only writable SimVars will take effect. Use get_simvar (docs mode) to check whether a variable is settable before calling this tool.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 5,
  "method": "tools/call",
  "params": {
    "name": "set_simvar_value",
    "arguments": {
      "name": "AUTOPILOT ALTITUDE LOCK VAR",
      "unit": "feet",
      "value": 10000
    }
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 5,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"name\":\"AUTOPILOT ALTITUDE LOCK VAR\",\"success\":true,\"unit\":\"feet\",\"value\":10000}"
      }
    ]
  }
}

Error codes

• BRIDGE_DISCONNECTED: The SimConnect bridge is not connected to the simulator.
• INVALID_ARGUMENT: name, unit, or value was not provided or has the wrong type.
• INTERNAL_ERROR: Unexpected bridge or SimConnect failure.

get_nearby_traffic

Return a list of AI and player aircraft within a given radius of the user aircraft. The player aircraft is always included. Returns position, heading, speed, and on-ground status for each aircraft.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each entry in traffic:

Example request

{
  "jsonrpc": "2.0",
  "id": 6,
  "method": "tools/call",
  "params": {
    "name": "get_nearby_traffic",
    "arguments": { "radius_meters": 50000 }
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 6,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"count\":2,\"radius_meters\":50000,\"traffic\":[{\"object_id\":1,\"title\":\"Airbus A320 Neo\",\"atc_id\":\"TAP123\",\"atc_airline\":\"TAP Air Portugal\",\"latitude\":38.77,\"longitude\":-9.13,\"altitude_ft\":8200,\"true_heading_deg\":274.0,\"ground_speed_kts\":210.5,\"on_ground\":false}]}"
      }
    ]
  }
}

Error codes: None. Errors (not connected, scan failure) are embedded as an error field in the response body rather than returned as MCP errors.

get_traffic_with_phase

Return nearby aircraft with enriched telemetry: vertical speed, actual ground track, inferred flight phase, parking state, runway occupancy, and aircraft category. Uses a single SimConnect round-trip with the same latency as get_nearby_traffic.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each entry in traffic (all fields from get_nearby_traffic plus):

Example request

{
  "jsonrpc": "2.0",
  "id": 7,
  "method": "tools/call",
  "params": {
    "name": "get_traffic_with_phase",
    "arguments": {}
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 7,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"count\":1,\"radius_meters\":25000,\"traffic\":[{\"object_id\":1,\"title\":\"Cessna 172\",\"atc_id\":\"N12345\",\"atc_airline\":\"\",\"category\":\"Prop\",\"latitude\":38.77,\"longitude\":-9.13,\"altitude_ft\":4500,\"true_heading_deg\":090.0,\"track_deg\":088.5,\"ground_speed_kts\":110.0,\"vertical_speed_fpm\":-200,\"on_ground\":false,\"in_parking_state\":false,\"on_any_runway\":false,\"flight_phase\":\"DESCENT\"}]}"
      }
    ]
  }
}

Error codes: None. Errors are embedded in the response body.

get_airports_in_range

Return a list of airports in the simulator’s loaded scenery area (reality bubble), sorted by distance from the player aircraft. By default only standard ICAO-format airports are returned.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each entry in airports:

Example request

{
  "jsonrpc": "2.0",
  "id": 8,
  "method": "tools/call",
  "params": {
    "name": "get_airports_in_range",
    "arguments": { "radius_km": 100 }
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 8,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"airports\":[{\"icao\":\"LPMA\",\"region\":\"LP\",\"latitude\":32.697,\"longitude\":-16.778,\"altitude_m\":58.0,\"distance_km\":0.3},{\"icao\":\"LPCC\",\"region\":\"LP\",\"latitude\":32.699,\"longitude\":-16.645,\"altitude_m\":98.0,\"distance_km\":14.9}],\"count\":2,\"expanded\":false,\"radius_km\":100}"
      }
    ]
  }
}

Error codes: None. Errors are embedded in the response body.

get_nearest_airport

Return the single closest airport to the player aircraft. Note: SimConnect’s facility list APIs may exclude the airport the player is currently on; use get_airports_in_range with expanded=true if you need to detect the current airport.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters: None.

Returns

An airport entry object with the same fields as entries returned by get_airports_in_range, or an object with an error field when not connected, no airports are found, or the scan fails.

Example request

{
  "jsonrpc": "2.0",
  "id": 9,
  "method": "tools/call",
  "params": {
    "name": "get_nearest_airport",
    "arguments": {}
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 9,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"icao\":\"LPCC\",\"region\":\"LP\",\"latitude\":32.699,\"longitude\":-16.645,\"altitude_m\":98.0,\"distance_km\":14.9}"
      }
    ]
  }
}

Error codes: None. Errors are embedded in the response body.

get_airport_details

Return detailed facility data for a specific airport by ICAO code. The default response includes name, coordinates, elevation, magnetic variation, closed status, runways, and ATC frequencies. Set expanded=true to also receive parking stands, helipads, instrument approaches, SIDs, and STARs.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns (default)

Additional fields when expanded=true

Example request

{
  "jsonrpc": "2.0",
  "id": 10,
  "method": "tools/call",
  "params": {
    "name": "get_airport_details",
    "arguments": { "icao": "LPMA" }
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 10,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"icao\":\"LPMA\",\"region\":\"LP\",\"name\":\"Madeira\",\"name64\":\"Cristiano Ronaldo International Airport\",\"latitude\":32.697,\"longitude\":-16.778,\"altitude_m\":58.0,\"magvar_deg\":-5.2,\"is_closed\":false,\"runway_count\":1,\"runways\":[{\"name\":\"05/23\",\"heading_deg\":54.0,\"length_m\":2781,\"width_m\":45,\"surface\":\"Asphalt\"}],\"frequencies\":[{\"type\":\"ATIS\",\"freq_mhz\":126.9,\"name\":\"Madeira ATIS\"}]}"
      }
    ]
  }
}

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• INVALID_ARGUMENT: icao must be 1–9 uppercase alphanumeric characters; region must be 0–4 uppercase alphanumeric characters.
• AIRPORT_NOT_FOUND: No airport matching the given ICAO code was found.
• AIRPORT_DETAILS_ERROR: SimConnect returned an error while fetching facility data.

get_vors_in_range

Return a list of VOR navigation stations in the simulator’s reality bubble, sorted by distance from the player aircraft.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each entry in vors:

Error codes: None. Errors (not connected) are embedded as an error field in the response body.

get_vor_details

Return detailed data for a specific VOR navigation station by ICAO code.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• INVALID_ARGUMENT: icao was not provided or is empty.
• VOR_NOT_FOUND: No VOR matching the given ICAO code was found.

get_ndbs_in_range

Return a list of NDB navigation stations in the simulator’s reality bubble, sorted by distance from the player aircraft.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each entry in ndbs:

Error codes: None. Errors are embedded as an error field in the response body.

get_ndb_details

Return detailed data for a specific NDB navigation station by ICAO code.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• INVALID_ARGUMENT: icao was not provided or is empty.
• NDB_NOT_FOUND: No NDB matching the given ICAO code was found.

get_waypoints_in_range

Return a list of waypoints in the simulator’s reality bubble, sorted by distance from the player aircraft.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each entry in waypoints:

Error codes: None. Errors are embedded as an error field in the response body.

get_waypoint_details

Return detailed data for a specific waypoint by ICAO code.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• INVALID_ARGUMENT: icao must be 1–9 uppercase alphanumeric characters; region must be 0–4 uppercase alphanumeric characters.
• WAYPOINT_NOT_FOUND: No waypoint matching the given ICAO code was found.

get_airport_taxiways

Return the taxiway network graph for a specific airport by ICAO code. The response contains three correlated arrays: names (taxiway letter strings), paths (directed edges referencing start/end node indices and a name index), and points (graph nodes including hold-short positions). Leave region empty for best results.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each entry in paths:

Each entry in points:

Example request

{
  "jsonrpc": "2.0",
  "id": 17,
  "method": "tools/call",
  "params": {
    "name": "get_airport_taxiways",
    "arguments": { "icao": "EDDM" }
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 17,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"names\":[\"A\",\"B\",\"N\"],\"paths\":[{\"type\":\"TAXIWAY\",\"width_m\":23.0,\"start_node\":0,\"end_node\":1,\"name_index\":0,...}],\"points\":[{\"type\":\"NORMAL\",\"orientation\":\"NONE\",\"bias_x_m\":-823.5,\"bias_z_m\":441.2}]}"
      }
    ]
  }
}

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• INVALID_ARGUMENT: icao must be 1–9 uppercase alphanumeric characters; region must be 0–4 uppercase alphanumeric characters.
• TAXIWAY_NOT_FOUND: No taxiway data was found for the given ICAO code.
• TAXIWAY_ERROR: SimConnect returned an error while fetching taxiway data.

get_taxiway_names

Return only the taxiway letter/name strings for an airport by ICAO code. Lightweight alternative to get_airport_taxiways when only the taxiway label list is needed — no paths or points are returned.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 19,
  "method": "tools/call",
  "params": {
    "name": "get_taxiway_names",
    "arguments": { "icao": "EDDM" }
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 19,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"icao\":\"EDDM\",\"name_count\":12,\"names\":[\"A\",\"B\",\"C\",\"D\",\"E\",\"F\",\"G\",\"H\",\"J\",\"K\",\"M\",\"N\"]}"
      }
    ]
  }
}

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• INVALID_ARGUMENT: icao must be 1–9 uppercase alphanumeric characters; region must be 0–4 uppercase alphanumeric characters.
• TAXIWAY_NOT_FOUND: No taxiway data was found for the given ICAO code.
• TAXIWAY_ERROR: SimConnect returned an error while fetching taxiway data.

get_airport_parkings

Return all parking stands, gates, and ramps at a specific airport by ICAO code. Each entry includes type, name, suffix, number, heading, radius, and position offsets from the airport reference point. Returns the full TAXI_PARKING record — more fields than the abbreviated stands array in get_airport_details. Leave region empty for best results.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each entry in parkings:

Example request

{
  "jsonrpc": "2.0",
  "id": 18,
  "method": "tools/call",
  "params": {
    "name": "get_airport_parkings",
    "arguments": { "icao": "EDDM" }
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": 18,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"count\":2,\"parkings\":[{\"type\":\"GATE\",\"name\":\"Gate\",\"suffix\":\"A\",\"number\":1,\"orientation\":\"NONE\",\"heading_deg\":180.0,\"radius_m\":40.0,\"bias_x_m\":120.5,\"bias_z_m\":-310.2},{\"type\":\"RAMP_GA\",\"name\":\"Ramp GA\",\"suffix\":\"\",\"number\":2,\"orientation\":\"NONE\",\"heading_deg\":90.0,\"radius_m\":12.0,\"bias_x_m\":-50.0,\"bias_z_m\":80.0}]}"
      }
    ]
  }
}

Error codes

• BRIDGE_DISCONNECTED: Not connected to the simulator.
• INVALID_ARGUMENT: icao must be 1–9 uppercase alphanumeric characters; region must be 0–4 uppercase alphanumeric characters.
• PARKING_NOT_FOUND: No parking data was found for the given ICAO code.
• PARKING_ERROR: SimConnect returned an error while fetching parking data.

Airport, weather and navigation tools

The ten tools below are built on the mrlm-net/simconnect Go library (pkg/airport and pkg/nav), which the server runs on the bridge’s SimConnect connection. They are registered only with the real SimConnect bridge — a server started with the mock bridge does not list them.

Shared behaviour:

• Airport data (layouts, taxi network, stands, procedures) is loaded from the simulator on first use and cached. SimConnect does not answer for an unknown airport, so an unknown ICAO code ends in NOT_FOUND after about 20 s (procedures: about 30 s).
• Weather comes from the simulator’s ambient weather at the user aircraft only. SimConnect has no gust, ceiling or dewpoint variables. get_active_runway, get_atis and plan_flight (departure runway) use it, so they are right for the airport the aircraft is at or near.
• Airways are crawled from the simulator’s navdata on demand around the route. The first crawl of an area takes a few seconds and is cached; the crawl radius is capped at 400 NM from the route midpoint, beyond which the route is flown direct.
• ICAO airport codes are 3–8 letters or digits (case-insensitive).

Examples show the tool result’s text content, formatted; the JSON-RPC envelope is the same as for the tools above. Long arrays are abridged (…).

Error codes used by these tools:

• INVALID_ARGUMENT: A parameter is missing or malformed, or names something the airport does not have (procedure, runway, stand).
• NOT_FOUND: The airport or fix is not in the simulator’s data.
• BRIDGE_DISCONNECTED: Not connected to the simulator.
• TIMEOUT: The simulator did not answer in time.
• SIM_ERROR: Any other simulator or loader failure.
• NO_ROUTE: No taxi route or airway route between the given points.
• PLAN_ERROR: plan_flight could not build the plan or its .pln file.

Airport procedures & ground

get_airport_procedures

List an airport’s SIDs, STARs and instrument approaches from the simulator’s navdata, or resolve one into the points it flies. Without name: every procedure (optionally only those of runway) with its runways and transitions. With name: the SID, STAR or approach as points in order — ident, position, ARINC 424 leg type, true course, altitude window (ft) and speed limit, IAF/FAF/MAP — for the runway and transition given. Also returns the magnetic variation.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns (list, without name)

Returns (resolved, with name)

Each point: ident, kind, lat, lon, leg (ARINC 424 leg type, e.g. "TF"), course_true, alt_min_ft, alt_max_ft, speed_max_kts, and the flags fly_over, iaf, faf, map, vectors (zero and false values are omitted).

Example request

{
  "jsonrpc": "2.0",
  "id": 20,
  "method": "tools/call",
  "params": {
    "name": "get_airport_procedures",
    "arguments": { "icao": "LKPR", "name": "ILS 24" }
  }
}

Example response (abridged)

{
  "icao": "LKPR", "kind": "APPROACH", "name": "ILS 24", "runway": "", "transition": "", "magvar": …,
  "points": [
    { "ident": "…", "lat": …, "lon": …, "leg": "IF", "alt_min_ft": …, "iaf": true },
    …,
    { "ident": "RW24", "lat": …, "lon": …, "leg": "…", "course_true": …, "map": true }
  ],
  "missed_approach": [ … ]
}

Error codes

• INVALID_ARGUMENT: icao is not an airport ICAO code; name is not a SID, STAR or approach of the airport; or the SID/STAR serves several runways and runway was not given.
• NOT_FOUND / TIMEOUT: Unknown airport or no procedures loaded (after about 30 s).
• BRIDGE_DISCONNECTED, SIM_ERROR: See above.

plan_taxi_route

Plan a taxi route on the simulator’s taxi network the way ATC would give it: fewer turns, no needless runway crossings, taxiways the aircraft fits. direction=departure: from the parking stand to the holding point of the runway (full length, or at entry). direction=arrival: from a runway exit (exit, or the one reached after rollout_m) to the stand. Use get_runway_entries_exits and find_stands for names.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 21,
  "method": "tools/call",
  "params": {
    "name": "plan_taxi_route",
    "arguments": { "icao": "LKPR", "parking": "C22", "runway": "24" }
  }
}

Example response (MSFS 2024)

{
  "icao": "LKPR", "direction": "departure", "parking": "C22", "runway": "24",
  "instruction": "taxi to holding point runway 24 via H1 H A",
  "length_m": 1595, "taxiways": ["H1", "H", "A"], "runway_crossings": [], "hold_short": "06/24"
}

Error codes

• INVALID_ARGUMENT: icao, parking or runway missing; direction not departure/arrival; unknown stand (use find_stands).
• NO_ROUTE: No route found, or the runway or exit does not exist (the message lists the runway’s exits).
• NOT_FOUND, TIMEOUT, BRIDGE_DISCONNECTED, SIM_ERROR: See above.

get_runway_entries_exits

List the taxiways onto a runway end for departures (nearest the threshold first, with the runway length remaining ahead) and the exits for landings on it (distance from the threshold, angle, high-speed, side). Names feed plan_taxi_route’s entry and exit.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 22,
  "method": "tools/call",
  "params": {
    "name": "get_runway_entries_exits",
    "arguments": { "icao": "LKPR", "runway": "24" }
  }
}

Example response (abridged)

{
  "icao": "LKPR", "runway": "24",
  "entries": [
    { "taxiway": "A", "from_threshold_m": …, "remaining_m": …, "angle": … },
    …
  ],
  "exits": [
    { "taxiway": "D", "from_threshold_m": …, "angle": …, "side": "…" },
    …
  ]
}

Error codes

• INVALID_ARGUMENT: icao or runway missing, or the airport has no such runway end.
• NOT_FOUND, TIMEOUT, BRIDGE_DISCONNECTED, SIM_ERROR: See above.

find_stands

Find parking stands at an airport that fit an aircraft: stand label, type, size class (small/medium/heavy), radius, heading, the airlines the scenery assigns, and the stands it overlaps (split or alternate stands). Filter by wing span, airline (stands without airlines serve any) and gates only.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 23,
  "method": "tools/call",
  "params": {
    "name": "find_stands",
    "arguments": { "icao": "LKPR", "wingspan_m": 64.8 }
  }
}

Example response (abridged)

{
  "icao": "LKPR", "total": 4, "count": 4,
  "stands": [
    { "label": "…", "type": "…", "size": "heavy", "radius_m": …, "heading_true": …, "overlaps": ["…"], "lat": …, "lon": … },
    …
  ]
}

Error codes

• INVALID_ARGUMENT: icao is not an airport ICAO code, or limit is outside 1–500.
• NOT_FOUND, TIMEOUT, BRIDGE_DISCONNECTED, SIM_ERROR: See above.

Weather & runway in use

get_weather

Return the weather at the user aircraft: wind (degrees true, knots), visibility, temperature, QNH (hPa and inHg), precipitation, whether the aircraft is in cloud, and icing conditions (visible moisture at or below +10 °C). SimConnect has no gust, ceiling or dewpoint variables.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

None.

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 24,
  "method": "tools/call",
  "params": { "name": "get_weather", "arguments": {} }
}

Example response (illustrative)

{
  "wind_dir_true": 100, "wind_kts": 8, "calm": false, "visibility_m": 20000, "temp_c": 12,
  "qnh_hpa": 1025, "qnh_inhg": 30.27, "precip": "none", "in_cloud": false, "icing_conditions": false,
  "note": "Measured at the user aircraft: the simulator gives the ambient weather there only. Gusts, ceiling and dewpoint are not available from SimConnect."
}

Error codes

• TIMEOUT: No weather from the simulator within 10 s.
• BRIDGE_DISCONNECTED, SIM_ERROR: See above.

get_active_runway

Work out the runways in use at an airport as a tower would: the preferential runway if the wind allows, else the one with the most headwind, within the airport’s tailwind and crosswind limits. Returns the departure and arrival runway, wind components, whether an ILS or visual approach is expected and the best published approach, the transition altitude and level. Once a runway is in use it stays in use while the wind allows it (up to 5 kt tailwind), as at a real airport; a calm or variable wind doesn’t swap it. The spawn tools and the schedule use the same runways. Uses the weather at the user aircraft, so it is right for the airport the aircraft is at or near.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 25,
  "method": "tools/call",
  "params": {
    "name": "get_active_runway",
    "arguments": { "icao": "LKPR" }
  }
}

Example response (MSFS 2024, weather abridged)

{
  "icao": "LKPR", "departure_runway": "06", "arrival_runway": "06",
  "headwind_kts": 7, "crosswind_kts": 5, "within_wind_limits": true,
  "approach_kind": "visual/RNAV", "approach": "ILS 06",
  "transition_altitude_ft": 5000, "transition_level": 60, "preferred_runways": ["24", "06"],
  "weather": { "wind_dir_true": 100, "wind_kts": 8, "qnh_hpa": 1025, … }
}

Error codes

• INVALID_ARGUMENT: icao is not an airport ICAO code.
• NOT_FOUND, TIMEOUT, BRIDGE_DISCONNECTED, SIM_ERROR: See above.

get_atis

Compose the ATIS broadcast of an airport from the simulator’s weather and the runway in use: information letter, time, runways, approach, wind, visibility, temperature, QNH, transition level. Returns the text as written and as spoken (phonetic, for text-to-speech). Uses the weather at the user aircraft.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 26,
  "method": "tools/call",
  "params": {
    "name": "get_atis",
    "arguments": { "icao": "LKPR", "letter": "B" }
  }
}

Example response (MSFS 2024, spoken and note abridged)

{
  "icao": "LKPR", "letter": "B",
  "text": "Ruzyne information Bravo, time 2330, runway in use 06, wind 100 degrees 8 knots, visibility 10 kilometers or more, temperature 12, QNH 1025, transition level 60, advise on initial contact you have information Bravo.",
  "spoken": "Ruzyne information Bravo, time two three three zero, runway in use zero six, …",
  "note": "Measured at the user aircraft: …"
}

Error codes

• INVALID_ARGUMENT: icao is not an airport ICAO code, or letter is not a single letter A–Z.
• NOT_FOUND, TIMEOUT, BRIDGE_DISCONNECTED, SIM_ERROR: See above.

Navigation & flight planning

get_fix

Look up an enroute fix in the simulator’s navdata: a waypoint, VOR or NDB with its position, frequency (MHz for a VOR, kHz for an NDB), name, and the airways through it (previous fix, airway, next fix). Identifiers repeat between waypoints, VORs and NDBs; without kind all three are tried.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Each fix: key (IDENT.REGION.KIND, usable as find_airway_route’s from/to), ident, region, kind ("waypoint", "VOR" or "NDB"), name, freq, lat, lon, terminal (present when true), airways ("PREV AIRWAY NEXT" per airway through the fix).

Example request

{
  "jsonrpc": "2.0",
  "id": 27,
  "method": "tools/call",
  "params": {
    "name": "get_fix",
    "arguments": { "ident": "VOZ", "region": "LK" }
  }
}

Example response (MSFS 2024)

{
  "count": 1,
  "fixes": [
    {
      "key": "VOZ.LK.V", "ident": "VOZ", "region": "LK", "kind": "VOR", "name": "VOZICE", "freq": 116.95,
      "lat": …, "lon": …,
      "airways": ["M725 TABEM", "T709 USUPA", "Z21 NELPA", "VAKLA Z30"]
    }
  ]
}

Error codes

• INVALID_ARGUMENT: ident must be 1–9 and region 0–4 uppercase letters or digits; kind must be W, V or N.
• NOT_FOUND: No such fix.
• BRIDGE_DISCONNECTED, SIM_ERROR: See above.

find_airway_route

Find the airway route between two enroute fixes over the simulator’s airway network (A*, with a penalty for every change of airway). The network is crawled from the simulator on demand around the two fixes (a few seconds the first time; cached). When the fixes are not connected, or the airways are over max_stretch times the direct distance, the route is direct (DCT).

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 28,
  "method": "tools/call",
  "params": {
    "name": "find_airway_route",
    "arguments": { "from": "VOZ.LK.V", "to": "OKF.LK.V" }
  }
}

Example response (MSFS 2024, abridged)

{
  "route": "VOZ M725 OKF", "distance_nm": 42.8, "direct_nm": …,
  "steps": [
    { "fix": "VOZ.LK.V", "lat": …, "lon": …, "distance_nm": 0 },
    …,
    { "airway": "M725", "fix": "OKF.LK.V", "lat": …, "lon": …, "distance_nm": … }
  ],
  "graph": { "fixes_crawled_within_nm": …, "segments": … }
}

Error codes

• INVALID_ARGUMENT: from or to is not IDENT[.REGION[.KIND]], or the kind is not W, V or N.
• NOT_FOUND: A fix does not exist.
• NO_ROUTE: No route between the fixes.
• TIMEOUT: The crawl did not finish within 90 s (it completes in the background for the next call).
• BRIDGE_DISCONNECTED, SIM_ERROR: See above.

plan_flight

Plan an IFR flight between two airports from the simulator’s navdata: runways in use (weather at the user aircraft for the departure), SID, airways (crawled on demand; direct where they detour), STAR and best approach, semicircular cruise level, vertical profile with TOC/TOD, distance, time and fuel for the aircraft type. Returns the ICAO route and the waypoints; optionally the MSFS .pln file. Takes up to a minute the first time (airport data and the airway crawl).

load_into_sim=true changes the simulator’s flight plan. The plan is written as a .pln file to %TEMP%\simconnect-mcp and loaded with SimConnect_FlightPlanLoad as the user aircraft’s flight plan.

Requirements: Windows + MSFS 2020 or 2024 running with SimConnect enabled.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 29,
  "method": "tools/call",
  "params": {
    "name": "plan_flight",
    "arguments": { "departure": "LKPR", "arrival": "LOWW", "aircraft_type": "A20N" }
  }
}

Example response (MSFS 2024, abridged)

{
  "departure": "LKPR", "arrival": "LOWW", "aircraft_type": "A20N",
  "departure_runway": "06", "arrival_runway": "16",
  "sid": "VOZ5D", "star": "LANU7W", "approach": "ILS 16",
  "route": "VOZ5D VOZ M725 LANUX LANU7W",
  "cruise_fl": 290, "distance_nm": 166, "ete_minutes": 32,
  "fuel_kg": { "totalKg": 2724, … },
  "waypoints": [ { "ident": "VOZ", "phase": "SID", "alt_ft": …, "dist_nm": …, "lat": …, "lon": … }, … ]
}

Error codes

• INVALID_ARGUMENT: departure or arrival is not an airport ICAO code.
• NOT_FOUND: Unknown airport (after about 20 s).
• PLAN_ERROR: The plan or its .pln file could not be built.
• TIMEOUT: The plan did not finish within 90 s.
• BRIDGE_DISCONNECTED, SIM_ERROR: Not connected, or loading the flight plan into the simulator failed.

AI traffic tools

The AI traffic and ATC tools run on the library’s traffic engine, pkg/traffic/world (the engine of the library’s airport map), on the server’s own SimConnect connection. The engine starts with the first tool that needs it, and runs again after the simulator reconnects, with its schedule, real traffic and corridor set again. What it does for each aircraft of ours:

• Departures: stand services from the airport’s fleet (a fuel truck; boarding stairs and a GPU at a remote stand), a pushback with a tug, the taxi route to the runway, line-up, take-off and the SID. The crew talks to delivery, ground and tower.
• Arrivals: en route or on a STAR, sequenced by the approach controller (speed, vectors, holds), the approach, landing, vacating and taxi to a stand. Turnarounds stay on their stand and depart again.
• ATC: a tower per runway, landing sequences, airborne separation with conflict resolutions, and the radio (get_atc_log).

Manual or automatic. An aircraft the engine clears by itself is automatic. One spawned with hold_for_clearances / hold_for_clearance (the default), or given any atc_clearance other than remove, is manual: it waits for your clearances. atc_clearance with action: "manual", on: false hands it back to the engine.

Shutdown. When the server stops it turns the schedule and corridor off and removes our aircraft from the simulator. En route aircraft the schedule created are not on the engine’s list; they go when the connection closes.

IDs. The engine’s library helpers sit at IDBase 950,000,000; its fixed IDs (2000–2021, 8200+, 10010, 20000–31279) clash with none of the server’s.

list_aircraft_models

The installed models the engine can spawn: titles, with the livery after the separator.

Returns count (all matching) and models.

spawn_departure

Puts an AI departure of ours on a stand. The stand, the runway in use, the SID and the model are chosen when not given. The traffic engine gives it its stand services (fuel truck; stairs and GPU at a remote stand), a pushback with a tug, the taxi route, line-up, take-off and its SID, and its crew talks to delivery, ground and tower. With hold_for_clearances (default) it waits for atc_clearance at each step; false lets the engine’s tower clear it.

Returns the aircraft as list_our_traffic shows it.

Error codes: INVALID_ARGUMENT, NOT_FOUND (stand), NOT_APPLICABLE (the engine refused the spawn, e.g. no flight plan), BRIDGE_DISCONNECTED, TIMEOUT.

spawn_arrival

Puts an AI arrival of ours into the simulator, on its STAR (or straight in with star: "none"). It is sequenced by the approach controller, lands, vacates and taxis to a stand.

list_our_traffic

Our aircraft, spawned or scheduled. Each one has:

• Identity: id, callsign, kind (departure, arrival), rules, icao, model, squawk.
• Plan: stand, runway, procedure.
• State: state, atc and frequency (the position working it), onGround, position, heading, groundSpeed, holdingShortOf, taxiRemainingM, entry, deicing, pushbackHeld, error.
• Control: manual and actions (what atc_clearance takes now).
• Ground vehicles: vehicles, each with kind, title, state (waiting, inbound, attached, fuelling, outbound, removed), position, heading and route.
• Real traffic: real, observedId, registration.

Before the engine has started it returns no aircraft and engine: "not started".

atc_clearance

A clearance or instruction to one of ours. Any action but remove puts the aircraft under manual control.

Returns the aircraft after the action; removed: true after remove.

Error codes: NOT_FOUND (not one of ours), NOT_APPLICABLE (the action does not fit now: see actions), INVALID_ARGUMENT.

get_traffic_picture

Every aircraft the simulator has around the user aircraft, or around an airport: call sign, title, phase (parked, taxiing, runway, departing, enroute, arriving, holding), the airport it belongs to, position, altitude, AGL, ground speed, heading and vertical speed. The user’s and ours are marked. It reads the engine’s picture as it is (the engine’s area is not moved) and keeps the aircraft within radius_nm; the first call can take a few seconds.

generate_schedule

Generate a realistic airline schedule for airports: flights with call sign, airline, aircraft type, origin, destination, STD/STA (UTC) and distance, following time-of-day waves and each airline’s bases and fleet (17 European airlines, about 80 airports). Deterministic for a seed. Pure computation — nothing is spawned; use it to pick flights for spawn_departure and spawn_arrival.

Requirements: Registered with the other traffic tools; it does not read the simulator.

Parameters

Returns

Example request

{
  "jsonrpc": "2.0",
  "id": 36,
  "method": "tools/call",
  "params": {
    "name": "generate_schedule",
    "arguments": { "airports": "LKPR", "hours": 1, "start": "2026-10-01T06:00:00Z" }
  }
}

Example response (abridged)

{
  "from": "2026-10-01T06:00:00Z", "hours": 1, "total": …, "count": …,
  "flights": [
    { "callsign": "…", "airline": "…", "type": "…", "origin": "LKPR", "destination": "…", "std": "…", "sta": "…", "distanceNM": … },
    …
  ]
}

Error codes

• INVALID_ARGUMENT: airports missing or not ICAO codes; hours, density or limit out of range; start not RFC 3339.

Airborne ATC tools

The engine runs, at each airport it works, a tower per runway, a landing sequence per runway end (spacing by wake, at least the minimum, more in low visibility), airborne separation with conflict resolutions for ours, and the radio. Manual aircraft are counted but never cleared or instructed by it.

get_landing_sequence

The landing sequences at an airport the engine works, or at all of them: per runway its approach conditions, lvp, and sequence. Each entry has callsign, number, leader, wake, spacingNM, spacingWhy, minimumNM, distanceToGoNM, eta, landing, delay (nanoseconds) and fixed (established).

approach_instruction

An approach controller’s instruction to one of our arrivals.

up / down move it a place in the landing order, slow loses another minute, hold holds at its STAR’s hold fix (release ends it), direct goes to the point (else to the final), joinfinal joins the final at the point, holdat holds at the point.

Error codes: NOT_FOUND (not in a sequence), NOT_APPLICABLE (not one of our arrivals, established), INVALID_ARGUMENT.

get_atc_log

The radio: the engine’s latest transmissions, oldest first, each with at, airport, frequency, position (delivery, ground, tower, approach), controller or pilot, callsign, intent, params and text.

get_conflicts

Airborne separation as the engine sees it: minNM, the closest pairs, open and past losses of separation, predicted conflicts, and the resolutions given to ours with what was said.

get_traffic_status

The engine’s state: running, connected, aircraft (ours), dropped_messages, the schedule, real_traffic and corridor settings, player (the user’s place in a landing sequence) and the last error.

get_traffic_airport_info

An airport as the engine works it: runways, use (the runways in use with head- and crosswind, within limits), atis (letter, text, spoken), ils, limits and weather. While our traffic runs there, this is what its ATC uses; get_atis and get_active_runway compute their own.

get_tcas

TCAS II for our airborne traffic. Each of ours sees every aircraft around it (ours, the user’s and other traffic) within 12 NM, as TCAS II does. It gets traffic advisories (TA) and resolution advisories (RA), flies an RA after the crew’s reaction time and reports it on the frequency (“TCAS RA”), then “clear of conflict, returning to assigned altitude”. Meanwhile approach gives it no instruction. Between two of ours the RAs are coordinated. Each aircraft’s advisory now is also on list_our_traffic as tcas (advisory, intruder, aural, sense).

Returns ta and ra (how many advisories now) and events, each with at, callsign, intruder, advisory (TA, RA or clear), aural, rangeNM and dzFt.

get_camera

The add-on camera (MSFS 2024) as the traffic engine drives it, and the scripted scenes it can play.

Parameters: none.

Returns camera, with mode (off, auto, follow, view, scene, tower), subject, shot, acquired (the add-on holds the camera), error, and sim / simView when the sim’s own camera was last set. It also returns scenes: key, name, description, for example 1-departure (DEMO007 from gate to climb-out), 2-arrival (a Lufthansa A320 from a 5 NM final to its stand) and 3-mixed.

set_camera

Drives the add-on camera through the traffic engine. While it holds the camera the user’s view is the camera’s; off gives it back to the simulator, and the server gives it back when it stops.

Returns the camera as get_camera does.

Error codes: INVALID_ARGUMENT, NOT_FOUND (not one of ours), NOT_APPLICABLE (e.g. the aircraft is not in the simulator yet, or no camera on this simulator), BRIDGE_DISCONNECTED, TIMEOUT.

set_player_clearance

Tells the engine what the user’s own ATC cleared the user aircraft to do. The engine never controls or calls the user aircraft. While the user lines up, takes off or lands on a runway, none of our traffic is cleared onto it. Landing, the user is in that runway’s landing sequence and our traffic fits around it. vacated ends it.

Returns the clearance and, landing, the user’s place (number, leader, spacing, distances to go).

Scheduled traffic tools

start_schedule runs the engine’s scheduled traffic at airports: an airline timetable (the same schedule as generate_schedule) and light aircraft in the circuit by day.

• Departures appear on their stand before their STD, get their stand services and push on time.
• Arrivals come in en route and join their STAR.
• Turnarounds and overflights are flown too.
• ATC: the engine’s tower, sequences and separation clear them.
• Removal: departed and parked aircraft are removed.

add_flights adds flights at chosen times, set_real_traffic and observe_traffic fly real-world aircraft instead of the timetable, and set_traffic_corridor keeps airliners around the user’s flight in cruise.

start_schedule

Calling it again changes the settings. Returns the schedule’s settings, now (traffic time), active and flight_count.

stop_schedule

No more aircraft appear; those flying finish their flights. With remove: true every aircraft of ours on the engine’s list is taken out now. Returns running and removed.

get_schedule

The schedule’s settings and now, and per airport (icao, default every scheduled airport) its boards: departures and arrivals. Each flight has callsign, airline, type, origin, destination, std, sta, status, stand, runway, estimated, note and, for a real one, observed.

add_flights

Adds flights to the running schedule at chosen times: an arrival just before the user’s ETA, say, or a departure just after their off-block. start_schedule with generator: false runs only these.