Aurora-4X-MCP

MCP (Model Context Protocol) server for Aurora 4X, providing integration capabilities with the Aurora 4X game.

Overview

Aurora-4X-MCP is a Model Context Protocol server implementation that enables integration with Aurora 4X, a complex 4X space strategy game. This server provides tools and resources for interacting with Aurora 4X game data and functionality.

Features

• SQLite database integration for game data management
• MCP protocol implementation using the official SDK
• Environment variable configuration support
• TypeScript-based implementation for type safety

Prerequisites

• Node.js (LTS version recommended)
• npm or yarn package manager
• Aurora 4X game installation
• TypeScript knowledge for development

Installation

1. Clone the repository:

git clone https://github.com/yourusername/Aurora-4X-MCP.git
cd Aurora-4X-MCP

2. Install dependencies:

npm install

3. Create a .env file in the root directory with your configuration:

# Add your environment variables here

MCP Client Configuration

To connect your MCP client to this server, you'll need to configure it properly. Create or modify your MCP client configuration file (typically located at ~/.cursor/mcp.json or equivalent based on your system):

{
  "mcpServers": {
    "aurora-4x-mcp": {
      "command": "npm",
      "args": ["--prefix", "/path/to/Aurora-4X-MCP", "start"],
      "cwd": "/path/to/Aurora-4X-MCP"
    }
  }
}

Replace /path/to/Aurora-4X-MCP with the actual path where you installed the server.

Usage

Development

To run the server in development mode with watch mode:

npm run dev

Production

To build and run the server in production:

npm run build
npm start

Available Scripts

• npm start - Build and start the server
• npm run dev - Run in development mode with watch
• npm run build - Build the TypeScript code
• npm run lint - Run ESLint for code quality

Project Structure

Aurora-4X-MCP/
├── src/
│   ├── app.ts           # Main application entry point
│   ├── db/              # Database related code
│   ├── tools/           # MCP tools implementation
│   └── resources/       # MCP resources implementation
├── dist/                # Compiled JavaScript output
├── data/                # Data storage
└── node_modules/        # Dependencies

Dependencies

Main Dependencies

• @modelcontextprotocol/sdk - MCP protocol implementation
• better-sqlite3 - SQLite database interface
• dotenv - Environment configuration

Development Dependencies

• typescript - TypeScript compiler
• eslint - Code linting
• Various TypeScript and ESLint plugins

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the ISC License - see the LICENSE file for details.

Acknowledgments

• Aurora 4X game developers
• Model Context Protocol team
• Contributors to the project

Support

For support, please open an issue in the GitHub repository or contact the maintainers.