Aurora 4x MCP

Aurora-4X-MCP

用于Aurora 4X的MCP（模型上下文协议）服务器，提供与Aurora 4X游戏的集成功能。

概述

Aurora-4X-MCP是一个模型上下文协议服务器实现，可以与复杂的4X空间战略游戏Aurora 4X集成。该服务器提供与Aurora 4X游戏数据和功能交互的工具和资源。

特性

• 用于游戏数据管理的SQLite数据库集成
• 使用官方SDK实现MCP协议
• 环境变量配置支持
• 基于TypeScript的类型安全实现

先决条件

• Node.js 22+（内置需要 node:sqlite 模块）
• npm或yarn包管理器
• Aurora 4X游戏安装
• TypeScript开发知识

安装

1. 克隆存储库：

git clone https://github.com/Brennall/aurora-4x-mcp.git
cd aurora-4x-mcp

1. 安装依赖项：

npm install

1. 创建一个 .env 根目录中包含您的配置的文件：

AURORA_DB_PATH=C:\Aurora\AuroraDB.db

MCP客户端配置

要将MCP客户端连接到此服务器，您需要正确配置它。创建或修改MCP客户端配置文件（通常位于 ~/.cursor/mcp.json 或基于您的系统的同等产品）：

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

替换 /path/to/aurora-4x-mcp 使用您安装服务器的实际路径。

用法

发展

要在监视模式下以开发模式运行服务器，请执行以下操作：

npm run dev

生产

要在生产环境中构建和运行服务器，请执行以下操作：

npm run build
npm start

可用脚本

• npm start -构建并启动服务器
• npm run dev -使用手表在开发模式下运行
• npm run build -构建TypeScript代码
• npm run lint -运行ESLint以提高代码质量

项目结构

aurora-4x-mcp/
├── src/
│   ├── app.ts          # Main application entry point
│   ├── db/             # Database related code (node:sqlite wrapper)
│   ├── tools/          # MCP tools implementation
│   └── resources/      # MCP resources implementation
├── dist/               # Compiled JavaScript output
├── data/               # Data storage
├── llms.txt            # AI-friendly tool documentation
└── node_modules/       # Dependencies

AI文档

该项目包括 llms.txt 文件后面 llms.txt规范它提供了一个完整的工具目录，包括参数描述、输出模式、安全约束和使用说明，针对LLM消费进行了优化。

想让你的人工智能助手了解这个MCP服务器吗？ 将其指向原始文件：

Fetch https://raw.githubusercontent.com/Brennall/aurora-4x-mcp/main/llms.txt and read the Aurora 4X MCP documentation

这为AI提供了正确使用工具所需的一切——每个工具返回的内容、参数的含义以及内置的安全过滤器——而无需解析源代码或通过反复试验发现输出形状。

依赖项

主要依赖关系

• @modelcontextprotocol/sdk -MCP协议实现
• node:sqlite -Node.js内置SQLite模块（Node 22+，无需外部包）
• dotenv -环境配置

发展依赖性

• typescript -TypeScript编译器
• eslint -代码linting
• 各种TypeScript和ESLint插件

贡献

1. 分叉存储库
2. 创建功能分支(git checkout -b feature/amazing-feature)
3. 提交您的更改(git commit -m 'Add some amazing feature')
4. 推到分支(git push origin feature/amazing-feature)
5. 打开拉取请求

许可证

此项目根据ISC许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢

• thirionlogan/Aurora-4X-MCP -原始项目
• Aurora 4X游戏开发者
• 模型上下文协议团队

支持

如需支持，请在GitHub存储库中打开问题。