Geofs Flight Simulator

🚀 GeoFS MCP Server

A Model Context Protocol (MCP) server for the GeoFS flight simulator, enabling AI models to control and interact with aircraft in the flight simulator.

✨ Features

• 🛫 Control aircraft flight parameters (throttle, heading, etc.)
• 📊 Obtain real-time flight data (position, speed, attitude)
• 🗺️ Navigate between waypoints and airports
• ✈️ Select different aircraft models
• 🔄 Execute flight procedures (takeoff, landing)

📋 Prerequisites

• Node.js (v14 or higher)
• npm or yarn
• A modern web browser (Chrome is recommended)

📦 Installation

1. Clone this repository:

   git clone https://github.com/yourusername/geofs-mcp-server.git
   cd geofs-mcp-server
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

💻 Usage Examples

Basic Usage - Start the Server

1. Start the MCP server:

   npm start
   

2. The server will open a browser window and redirect to GeoFS.

   • You may need to log in to GeoFS if required.
   • The server will start accepting commands after GeoFS is fully loaded.

3. The MCP server will run at the following addresses:

   • HTTP: http://localhost:3000
   • WebSocket: ws://localhost:3000

Advanced Usage - Use with AI Models

This MCP server can be used with AI models that support the Model Context Protocol, allowing them to:

1. Control the aircraft in the simulator.
2. Obtain flight data and simulator status.
3. Execute complex flight procedures.
4. Plan and follow flight routes.

API Endpoints

• GET /mcp - Get server capabilities and available endpoints.
• GET /mcp/aircraft - Get current aircraft data.
• POST /mcp/aircraft - Control aircraft parameters.
• GET /mcp/flight-data - Get comprehensive flight data.
• POST /mcp/navigation - Set navigation parameters.
• GET /mcp/simulation - Get simulator status.
• POST /mcp/simulation - Control simulator parameters.

WebSocket Commands

The server also supports WebSockets for real-time communication:

// Example WebSocket message
{
  "id": 1,
  "type": "command",
  "command": "Adjust throttle"
}

Example Client

To connect to the MCP server and control the aircraft, you can use the following JavaScript client code:

const ws = new WebSocket('ws://localhost:3000');
ws.onmessage = (event) => {
    console.log('Received message:', event.data);
};

How It Works

The MCP server provides an interface for the GeoFS flight simulator, allowing external systems to interact with it via HTTP and WebSocket protocols. It supports real-time data transmission and command control, enabling AI models to seamlessly integrate into the flight simulation environment.

🤝 Contribution Guidelines

If you want to contribute to this project, please refer to the CONTRIBUTING.md file.

📄 License

This project is protected under the LICENSE agreement.

🙏 Acknowledgments

Thanks to the following individuals and organizations for their contributions to the project:

• The development team
• Community supporters
• And other partners