火焰_mcp_服务器
项目介绍
Flame MCP 服务器
这是一个模型上下文协议（MCP）服务器，提供对Flame游戏引擎文档的全面访问，适用于像Claude Desktop和Amazon Q Developer这样的AI助手。
🎯 功能概述
- 文档访问：提供对完整Flame引擎文档的可搜索访问
- 教程系统：提供逐步的游戏开发教程（太空射击游戏、平台游戏、克朗代克）
- 本地缓存：本地存储文档以实现快速离线访问
- MCP集成：与Claude Desktop和Amazon Q CLI无缝集成
- 搜索工具：在所有文档和教程中进行智能搜索
🚀 快速开始
1. 构建和设置
# 克隆并构建服务器
git clone <repository-url>
cd flame_mcp_server
./build_clean.sh
这将：
- 安装Dart依赖项
- 构建MCP服务器可执行文件
- 下载并缓存所有Flame文档（约146个文件）
2. 配置您的MCP客户端
Amazon Q Developer
添加到您的MCP配置：
{
"mcpServers": {
"flame-docs": {
"command": "/absolute/path/to/flame_mcp_server/build/flame_mcp_live"
}
}
}
Claude Desktop
添加到claude_desktop_config.json：
{
"mcpServers": {
"flame-docs": {
"command": "/absolute/path/to/flame_mcp_server/build/flame_mcp_live"
}
}
}
配置文件位置：
- macOS：
~/Library/Application Support/Claude/claude_desktop_config.json - Windows：
%APPDATA%\\Claude\\claude_desktop_config.json - Linux：
~/.config/Claude/claude_desktop_config.json
3. 重启您的MCP客户端
重启Claude Desktop或Amazon Q CLI以加载Flame文档服务器。
🛠️ 可用工具
search_documentation
通过所有Flame文档搜索特定主题。
示例查询：
- "如何在Flame中实现碰撞检测？"
- "搜索组件系统示例"
- "查找关于精灵动画的信息"
tutorial
获取完整的逐步游戏开发教程。
可用教程：
- 太空射击游戏：完成6步教程，构建经典太空射击游戏
- 平台游戏：7步教程，构建横向卷轴平台游戏（Ember Quest）
- 克朗代克：5步教程，构建单人纸牌游戏
示例使用：
- "展示如何构建一个太空射击游戏" → 完整教程，包含所有步骤
- "我想创建一个平台游戏" → 完整平台游戏教程
- "列出所有可用教程" → 所有教程概览
📊 架构
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ MCP客户端 │ │ Flame MCP │ │ 文档缓存 │
│ (Claude/Amazon Q)│◄──►│ 服务器 │◄──►│ │
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼
┌──────────────────┐
│ GitHub API │
│ (flame-engine/ │
│ flame/doc) │
└──────────────────┘
🔧 配置
GitHub令牌（推荐）
为了更好的速率限制（5,000次请求/小时 vs 60次请求/小时）：
-
创建GitHub个人访问令牌：
- 前往GitHub设置 → 开发者设置 → 个人访问令牌
- 使用
public_repo范围生成新令牌
-
设置环境变量：
# macOS/Linux export GITHUB_TOKEN=your_token_here # Windows setx GITHUB_TOKEN "your_token_here"
📁 项目结构
flame_mcp_server/
├── bin/
│ ├── flame_mcp_live.dart # 主MCP服务器
│ └── flame_sync_standalone.dart # 文档同步工具
├── lib/src/
│ ├── flame_live_docs.dart # 文档管理
│ └── flame_mcp_live.dart # MCP协议实现
├── build/
│ └── flame_mcp_live # 编译的MCP服务器
├── flame_docs_cache/ # 缓存的文档（146个文件）
├── build_clean.sh # 构建和设置脚本
└── README.md # 该文件
🎮 示例交互
构建太空射击游戏
您："我想用Flame构建一个太空射击游戏。显示完整的教程。"
响应：完整的6步教程包括：
- 项目设置和基本游戏结构
- 玩家控制和图形
- 动画和视觉效果
- 敌人生成和移动
- 射击机制
- 碰撞检测和得分
学习组件
您："Flame组件系统是如何工作的？"
响应：关于组件系统的详细文档：
- 组件生命周期
- 组件层次结构
- 内置组件
- 创建自定义组件
- 组件通信
🔄 维护
刷新文档缓存
# 更新到最新的Flame文档
dart run bin/flame_sync_standalone.dart
重新构建服务器
# 清除重建，使用最新文档
./build_clean.sh
📋 先决条件
- Dart SDK：版本3.2.0或更高
- 互联网连接：初始文档同步所需
- MCP客户端：Claude Desktop，Amazon Q CLI或其他兼容客户端
🐛 故障排除
未找到服务器
- 确保在MCP配置中使用的是绝对路径到可执行文件
- 验证可执行文件存在：
ls -la build/flame_mcp_live - 检查文件权限：
chmod +x build/flame_mcp_live
没有搜索结果
- 运行
./build_clean.sh以重建缓存和服务器 - 检查缓存是否存在：
ls flame_docs_cache/ - 验证缓存内容：
find flame_docs_cache -name "*.md" | wc -l（应显示约146）
速率限制问题
- 设置GitHub个人访问令牌（参见配置部分）
- 在同步日志中检查速率限制状态
📈 性能
- 文档文件：146个Markdown文件
- 缓存大小：约3MB
- 同步时间：30-60秒（取决于网络）
- 内存使用：运行时小于50MB
- 启动时间：小于2秒
🤝 贡献
- 分叉仓库
- 创建功能分支
- 进行更改
- 使用
./build_clean.sh测试 - 提交拉取请求
📄 许可
该项目根据MIT许可发布。
🔗 相关链接
准备好开始用Flame构建游戏了吗？ 运行./build_clean.sh并将服务器添加到您的MCP客户端！🎮