msfs2024-mcp
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@msfs2024-mcp What's my current altitude and heading?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
msfs2024-mcp
✈️ Also in this repo:
a dark-mode PyQt6 electronic flight checklist app (Cessna 172S + Piper Archer II, normal/abnormal/emergency procedures) designed to float on top of MSFS 2024 —
pip install -e ".[checklist]", runmsfs-checklist.a Claude-powered controls setup advisor for the Honeycomb Alpha/Bravo and VelocityOne Rudder: per-aircraft binding plans with procedure coaching, plus LLM review of your exact hardware —
pip install -e ".[controls]", runmsfs-controls.
A Model Context Protocol server for Microsoft Flight Simulator 2024. It lets an MCP client (Claude Desktop, Claude Code, etc.) read live sim state and drive the aircraft across three capability layers:
Layer | Source | Covers | Setup |
1. SimConnect | Official Microsoft API ( | Thousands of SimVars, Events (controls), bundled aircraft state | MSFS running |
2. FSUIPC7 | Offset table ( | Values SimConnect doesn't cleanly expose; stable offsets | FSUIPC7 installed + running |
3. Raw memory |
| Escape hatch for anything else | Opt-in, admin rights |
Reality check: SimConnect, FSUIPC, and raw memory are Windows-only and require a running MSFS on the same machine (or LAN via
SimConnect.cfg). Run this server on that Windows host. Every layer degrades gracefully — if a layer isn't available, its tools return a structured{ "ok": false, "error": ... }explaining why, instead of crashing the server. So the server boots and the catalog/discovery tools work even before MSFS is up.
Install (on the Windows host with MSFS)
git clone <your-repo-url> msfs2024-mcp
cd msfs2024-mcp
python -m venv .venv
.venv\Scripts\activate
pip install -e . # server core (SimConnect layer)
pip install -e ".[transports]" # optional: adds the FSUIPC7 + raw-memory layers
copy .env.example .env # then edit if you likeLayer prerequisites:
SimConnect — installed automatically with the
SimConnectpip package, which ships its ownSimConnect.dll. Just have MSFS running and loaded into a flight.FSUIPC7 — install the
transportsextra (above), then download and run FSUIPC7 (free for basic offset access). Leave it running alongside MSFS. Bothfsuipcandpymemare optional and degrade gracefully when absent, so the core server and the GUI apps run without them.Raw memory — install the
transportsextra, setMSFS_ENABLE_MEMORY=truein.env, and run the server as Administrator. Off by default.
Related MCP server: jsbsim-mcp
Verify it works
python scripts\smoke_test.pyWith MSFS loaded into a flight you'll see a live aircraft-state snapshot and an event round-trip (nav lights toggle). Off-Windows or with the sim closed, it prints layer health and exits cleanly — which is how you know the graceful-degradation path is intact.
Platform-independent tests (catalog integrity + degradation) run anywhere:
pip install -e ".[dev]"
pytest -qWire into an MCP client
Claude Desktop / Claude Code — add to your MCP config (claude_desktop_config.json or .mcp.json):
{
"mcpServers": {
"msfs2024": {
"command": "python",
"args": ["-m", "msfs_mcp.server"],
"cwd": "C:\\path\\to\\msfs2024-mcp",
"env": { "MSFS_ENABLE_FSUIPC": "true", "MSFS_ENABLE_MEMORY": "false" }
}
}
}(If you pip install -e ., you can use the msfs-mcp console script instead of python -m msfs_mcp.server.)
HTTP mode & auto-start from the companion apps
The server also runs as a shared HTTP (streamable-http) service:
msfs-mcp --transport http --port 8787 # or MSFS_MCP_TRANSPORT=httpLaunching either companion app (msfs-checklist / msfs-controls)
automatically checks 127.0.0.1:8787 and starts this HTTP instance if it
isn't already running — detached, so it keeps serving after the app closes.
Server output goes to ~/.msfs_companion/mcp-server.log; set
MSFS_COMPANION_AUTOSTART=0 to opt out, MSFS_MCP_PORT to move the port.
MCP clients that support HTTP servers (e.g. Claude Code) can then attach at
http://127.0.0.1:8787/mcp:
claude mcp add --transport http msfs2024 http://127.0.0.1:8787/mcpStdio remains the default transport, so the Claude Desktop config above is unchanged.
Tool surface (23 tools)
Connection — connection_status, connect_sim
SimConnect / SimVars — get_simvar, get_simvars, set_simvar, get_aircraft_state
SimConnect / Events & autopilot — trigger_event, autopilot_set_heading, autopilot_set_altitude, autopilot_set_vertical_speed, autopilot_toggle_master
Discovery — list_simvars, list_events (searchable by keyword/category)
FSUIPC — fsuipc_status, fsuipc_read_offset, fsuipc_read_known, fsuipc_write_offset
Raw memory — memory_status, memory_attach, memory_module_base, memory_read, memory_read_pointer_chain, memory_write
Resources — msfs://telemetry/state, msfs://catalog/simvars, msfs://catalog/events
Prompts — preflight_briefing, fly_to_heading_altitude
Examples (natural language to the MCP client)
"What's my current altitude and heading?" →
get_aircraft_state"Find me every autopilot-related variable." →
list_simvars(category="autopilot")"Raise the landing gear and set flaps to the first notch." →
trigger_event('GEAR_UP'),trigger_event('FLAPS_INCR')"Engage the autopilot for heading 270 at 8000 feet." →
autopilot_toggle_master,autopilot_set_heading(270),autopilot_set_altitude(8000)"Read FSUIPC offset 0x0560 as a long." →
fsuipc_read_offset('0x0560', 'l')
Safety notes
Writes are real.
set_simvar,trigger_event, andfsuipc_write_offsetchange the running sim. Fine for your own local flight; think before scripting them.Raw memory is double-gated. It requires both
MSFS_ENABLE_MEMORY=trueandallow_write=trueper write call, because bad writes can crash MSFS. Pointer chains break on most sim updates — keep them version-pinned.Reads are harmless. All read paths are observation-only.
Extending the catalog
src/msfs_mcp/catalog.py is a curated subset, not the full SDK. The generic get_simvar / set_simvar / trigger_event tools reach any SimVar or Event by exact SDK name — add entries to the catalog only to make them discoverable. Full reference: the MSFS SDK SimVars and Event IDs docs.
Architecture
MCP client ──stdio──▶ msfs_mcp.server (FastMCP, 23 tools)
│
┌───────────────┼────────────────┐
▼ ▼ ▼
SimConnectClient FsuipcClient MemoryClient
(SimConnect.dll) (FSUIPC7) (pymem)
│ │ │
└──────── Microsoft Flight Simulator 2024 ────────┘Each client is a singleton with lazy connect, a thread lock around the native handle, and a uniform LayerUnavailable error contract that the server renders as structured JSON.
License
MIT
Companion apps
EFB Checklist — PyQt6 always-on-top electronic checklist (normal + emergency procedures, V-speeds) for flying alongside MSFS 2024. Ships with the Cessna 172S and Piper PA-28-181 Archer.
Available Tools
23 toolsautopilot_set_altitudeC
Set the autopilot target altitude in feet.
Inputs: altitude_ft (required). Returns: result
autopilot_set_headingA
Set the autopilot heading bug (0-359 degrees).
Inputs: heading_deg (required). Returns: result
autopilot_set_vertical_speedB
Set the autopilot target vertical speed in feet per minute (negative = descend).
Inputs: fpm (required). Returns: result
autopilot_toggle_masterA
Toggle the autopilot master on/off.
Inputs: no named parameters. Returns: result
connection_statusA
Report health of all three layers (enabled, imported, connected).
Inputs: no named parameters. Returns: result
connect_simA
Connect the SimConnect layer to a running MSFS. Idempotent.
Inputs: no named parameters. Returns: result
fsuipc_read_knownC
Read one of the built-in known offsets by key (see fsuipc_status.known_offsets).
Inputs: key (required). Returns: result
fsuipc_read_offsetA
Read a raw FSUIPC offset. offset_hex like '0x0560'; type_code one of b/B/h/H/d/u/l/L/f/s.
For strings use type_code='s' and pass a length.
Inputs: type_code (required), offset_hex (required), length. Returns: result
fsuipc_statusA
FSUIPC layer health plus the list of built-in known offset keys.
Inputs: no named parameters. Returns: result
fsuipc_write_offsetB
Write a raw FSUIPC offset. Use deliberately — offsets are global sim state.
Inputs: value (required), type_code (required), offset_hex (required). Returns: result
get_aircraft_stateA
Bundled snapshot: position, attitude, speeds, engine/fuel, config, autopilot, status.
Inputs: no named parameters. Returns: result
get_simvarA
Read any SimVar by its exact SDK name. Supports indices, e.g. 'TURB_ENG_N1:1'.
Inputs: name (required). Returns: result
get_simvarsA
Read several SimVars at once. Returns a name->value map; failures are inline.
Inputs: names (required). Returns: result
list_eventsA
Search the Event catalog by keyword and/or category. Empty args list everything.
Categories: engine, config, autopilot, controls, systems, sim.
Inputs: query, category. Returns: result
list_simvarsA
Search the SimVar catalog by keyword and/or category. Empty args list everything.
Categories: position, attitude, speed, engine, fuel, config, autopilot, systems, environment, status.
Inputs: query, category. Returns: result
memory_attachB
Attach to the MSFS process for raw reads. Off unless MSFS_ENABLE_MEMORY=true.
Inputs: process_name. Returns: result
memory_module_baseA
Return the base address of a loaded module (defaults to the main executable).
Inputs: module_name. Returns: result
memory_readB
Read a typed value at an absolute address. type_name: int32/uint32/int64/uint64/float/double/byte/ubyte.
Inputs: type_name (required), address_hex (required). Returns: result
memory_read_pointer_chainB
Resolve a pointer chain from a base address, then read the typed value at the end.
Inputs: base_hex (required), type_name (required), offsets_hex (required). Returns: result
memory_statusA
Raw-memory layer health (enabled flag, attach state, target process/pid).
Inputs: no named parameters. Returns: result
memory_writeB
Write to an absolute address. Double-gated: needs MSFS_ENABLE_MEMORY=true AND allow_write=true.
Inputs: value (required), type_name (required), address_hex (required), allow_write. Returns: result
set_simvarC
Write a settable SimVar (e.g. AUTOPILOT_HEADING_LOCK_DIR). Check 'settable' in the catalog.
Inputs: name (required), value (required). Returns: result
trigger_eventA
Fire a SimConnect Event (a control/command). Pass 'value' for events that take a parameter.
Examples: trigger_event('GEAR_TOGGLE'); trigger_event('HEADING_BUG_SET', 270).
Inputs: event (required), value. Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 23 tools
All 23 tools have clearly distinct purposes. Autopilot, connection, FSUIPC, SimVar, event, and memory groups are well-separated, with no ambiguous overlaps even between similar functions like set_simvar and trigger_event.
Tool names follow a consistent snake_case verb_noun pattern (e.g., autopilot_set_altitude, get_simvar, memory_read). Only minor exceptions like 'connection_status' are still intuitive and don't break the overall pattern.
23 tools is well-scoped for an MSFS interaction server. Each tool serves a distinct function across autopilot, SimVars, events, FSUIPC, memory, and connection layers, without unnecessary bloat or missing core functionality.
The server covers major interaction areas (autopilot, SimVars, events, FSUIPC, memory) with both read and write operations. A minor gap is the lack of a batch FSUIPC read, but generic SimVar and memory tools compensate. Overall comprehensive for low-level sim control.
Maintenance
Related MCP Connectors
Use AI models for chat, image, and video generation from Claude Code and other MCP hosts.
Meta Ads and Google Ads MCP server: 350+ tools for Claude, ChatGPT, Cursor and Codex.
Hosted Amazon Seller and Vendor MCP server for Claude, ChatGPT, Cursor, Codex, Gemini, Copilot.
Augments MCP Server - A comprehensive framework documentation provider for Claude Code
Related MCP Servers
- AlicenseAqualityDmaintenanceSimBrief MCP Server brings flight planning data directly into your AI workspace. Access your SimBrief flight plans (OFP), retrieve real-time METAR weather reports for any airport, and fetch pilot information - all through natural conversation. Built for virtual pilots who want to streamline their pre-flight briefing workflow in Microsoft Flight Simulator, X-Plane, and other flight simulation platf142MIT
- FlicenseNot gradedqualityDmaintenanceProvides the JSBSim flight-dynamics engine as an MCP service, enabling AI agents to control and simulate aircraft in real-time through natural language.-
- AlicenseNot gradedqualityCmaintenanceMCP server that lets ChatGPT or Codex control and inspect an X-Plane flight simulator through natural language, including reading/writing DataRefs, executing commands, and relocating the aircraft.MIT
- AlicenseAqualityCmaintenanceStreams live Euro Truck Simulator 2 / American Truck Simulator telemetry and driving analytics to any MCP-compatible AI assistant, with read-only tools for truck state, navigation, fuel, job status, speeding checks, eco scoring, trip summaries, rest advice, and recent events, plus a headless Claude coach agent.10MIT