AI导哈

Unreal引擎代码分析服务

一款为Unreal Engine代码库提供强大源代码分析能力的MCP服务器，支持类分析、层次结构映射、代码搜索等功能，适用于游戏开发和C++项目分析。

  • by ayeletstudioindia
  • TypeScript
  • 本地部署
  • 160 星标
  • 更新于
在 GitHub 查看 ayeletstudioindia/unreal-analyzer-mcp

使用说明

虚幻引擎代码分析器MCP服务器

一个模型上下文协议（MCP）服务器，为虚幻引擎代码库提供强大的源代码分析功能。该工具使Claude和Cline等AI助手能够深入理解和分析虚幻引擎源代码。

特性

  • 阶级分析：获取有关C++类的详细信息，包括方法、属性和继承
  • 层次结构映射：可视化并理解类继承层次结构
  • 代码搜索：使用上下文感知结果搜索代码
  • 参考文献检索：查找对类、函数或变量的所有引用
  • 子系统分析：分析虚幻引擎的主要子系统，如渲染、物理等。
  • 游戏类型知识：内置游戏类型、功能和实现模式的知识库
  • 模式检测与学习：识别常见的虚幻引擎模式并提供学习资源
  • 自定义代码库支持：分析您自己的虚幻引擎项目代码库

快速开始

安装

  1. 克隆此存储库：
git clone https://github.com/ayeletstudioindia/unreal-analyzer-mcp
cd unreal-analyzer-mcp
  1. 安装依赖项：
npm install
  1. 构建项目：
npm run build

配置

适用于Claude桌面应用程序

将以下内容添加到您的Claude桌面配置文件中(%APPDATA%\Claude\claude_desktop_config.json 在Windows上）：

{
  "mcpServers": {
    "unreal-analyzer": {
      "command": "node",
      "args": ["path/to/unreal-analyzer/build/index.js"],
      "env": {}
    }
  }
}

对于克莱恩

将以下内容添加到Cline MCP设置文件中(%APPDATA%\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json 在Windows上）：

{
  "mcpServers": {
    "unreal-analyzer": {
      "command": "node",
      "args": ["path/to/unreal-analyzer/build/index.js"],
      "env": {}
    }
  }
}

技术细节

分析仪是使用以下材料构建的：

  • TypeScript用于类型安全代码
  • 用于健壮C++解析的树形图
  • 用于AI助手集成的模型上下文协议SDK
  • Glob用于文件模式匹配

关键依赖关系：

  • @modelcontextprotocol/创建服务器：^0.1.0
  • 树保姆：^0.20.1
  • 树保姆cpp:^0.20.0
  • glob：^8.1.0

用法

在使用任何分析工具之前，您必须首先设置虚幻引擎源代码路径或自定义代码库路径：

设置分析

虚幻引擎源代码

{
  "name": "set_unreal_path",
  "arguments": {
    "path": "/path/to/UnrealEngine/Source"
  }
}

用于自定义C++代码库

{
  "name": "set_custom_codebase",
  "arguments": {
    "path": "/path/to/your/codebase"
  }
}

自定义代码库功能允许您分析任何C++项目。例如：

  • 游戏引擎（Unity、Godot、自定义引擎）
  • 图形库（OpenGL、Vulkan、DirectX）
  • 框架（Qt、Boost、SFML）
  • 任何C++应用程序或库

分析自定义游戏引擎的示例：

// Initialize with custom codebase
{
  "name": "set_custom_codebase",
  "arguments": {
    "path": "/path/to/game-engine"
  }
}

// Analyze engine's renderer class
{
  "name": "analyze_class",
  "arguments": {
    "className": "Renderer"
  }
}

// Find all shader-related code
{
  "name": "search_code",
  "arguments": {
    "query": "shader|glsl|hlsl",
    "filePattern": "*.{h,cpp,hpp}"
  }
}

// Get render system class hierarchy
{
  "name": "find_class_hierarchy",
  "arguments": {
    "className": "RenderSystem",
    "includeImplementedInterfaces": true
  }
}

Qt应用程序分析示例：

// Initialize with Qt project
{
  "name": "set_custom_codebase",
  "arguments": {
    "path": "/path/to/qt-app"
  }
}

// Find widget class definitions
{
  "name": "search_code",
  "arguments": {
    "query": "class.*:.*public.*QWidget",
    "filePattern": "*.h"
  }
}

// Analyze main window class
{
  "name": "analyze_class",
  "arguments": {
    "className": "MainWindow"
  }
}

// Find signal/slot connections
{
  "name": "find_references",
  "arguments": {
    "identifier": "connect",
    "type": "function"
  }
}

可用工具

1.类别分析

// Get detailed information about the AActor class
{
  "name": "analyze_class",
  "arguments": {
    "className": "AActor"
  }
}

输出示例：

{
  "name": "AActor",
  "properties": [
    {
      "name": "RootComponent",
      "type": "USceneComponent*",
      "access": "protected"
    }
    // ... other properties
  ],
  "methods": [
    {
      "name": "BeginPlay",
      "returnType": "void",
      "access": "protected",
      "virtual": true
    }
    // ... other methods
  ]
}

2.类层次分析

// Get the inheritance hierarchy for ACharacter
{
  "name": "find_class_hierarchy",
  "arguments": {
    "className": "ACharacter",
    "includeImplementedInterfaces": true
  }
}

输出示例：

{
  "class": "ACharacter",
  "inheritsFrom": "APawn",
  "interfaces": ["IMovementModeInterface"],
  "hierarchy": [
    "ACharacter",
    "APawn",
    "AActor",
    "UObject"
  ]
}

3.参考发现

// Find all references to the BeginPlay function
{
  "name": "find_references",
  "arguments": {
    "identifier": "BeginPlay",
    "type": "function"
  }
}

输出示例：

{
  "references": [
    {
      "file": "Actor.cpp",
      "line": 245,
      "context": "void AActor::BeginPlay() { ... }"
    },
    {
      "file": "Character.cpp",
      "line": 178,
      "context": "Super::BeginPlay();"
    }
  ]
}

4.代码搜索

// Search for physics-related code
{
  "name": "search_code",
  "arguments": {
    "query": "PhysicsHandle",
    "filePattern": "*.h",
    "includeComments": true
  }
}

输出示例：

{
  "matches": [
    {
      "file": "PhysicsEngine/PhysicsHandleComponent.h",
      "line": 15,
      "context": "class UPhysicsHandleComponent : public UActorComponent",
      "snippet": "// Component used for grabbing and moving physics objects"
    }
  ]
}

5.模式检测和最佳实践

分析器提供了两个强大的工具来理解和遵循虚幻引擎的最佳实践：

模式检测
// Detect patterns in a file
{
  "name": "detect_patterns",
  "arguments": {
    "filePath": "Source/MyGame/MyActor.h"
  }
}

输出示例：

{
  "patterns": [
    {
      "pattern": "UPROPERTY Macro",
      "description": "Property declaration for Unreal reflection system",
      "location": "Source/MyGame/MyActor.h:15",
      "context": "UPROPERTY(EditAnywhere, BlueprintReadWrite)\nfloat Health;",
      "improvements": "Consider adding a Category specifier for better organization\nConsider adding Meta tags for validation",
      "documentation": "https://docs.unrealengine.com/5.0/en-US/unreal-engine-uproperty-specifier-reference/",
      "bestPractices": "Use appropriate specifiers (EditAnywhere, BlueprintReadWrite)\nConsider replication needs (Replicated, ReplicatedUsing)\nGroup related properties with categories",
      "examples": "UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = \"Combat\")\nfloat Health;\nUPROPERTY(Replicated, Meta = (ClampMin = \"0.0\"))\nfloat Speed;"
    }
  ]
}
最佳实践指南
// Get best practices for specific Unreal concepts
{
  "name": "get_best_practices",
  "arguments": {
    "concept": "UPROPERTY"  // or UFUNCTION, Components, Events, Replication, Blueprints
  }
}

输出示例：

{
  "description": "Property declaration for Unreal reflection system",
  "bestPractices": [
    "Use appropriate specifiers (EditAnywhere, BlueprintReadWrite)",
    "Consider replication needs (Replicated, ReplicatedUsing)",
    "Group related properties with categories",
    "Use Meta tags for validation and UI customization"
  ],
  "examples": [
    "UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = \"Combat\")\nfloat Health;",
    "UPROPERTY(Replicated, Meta = (ClampMin = \"0.0\"))\nfloat Speed;"
  ],
  "documentation": "https://docs.unrealengine.com/5.0/en-US/unreal-engine-uproperty-specifier-reference/"
}

最佳实践指南涵盖了虚幻引擎的关键概念：

  • UPROPERTY：房产反映和曝光
  • UFUNCTION：功能反思与蓝图整合
  • 组件：组件创建和管理
  • 活动：活动处理和委派
  • 复制：网络复制设置
  • 蓝图：蓝图/C++交互模式

6.API文件查询

// Search the API documentation
{
  "name": "query_api",
  "arguments": {
    "query": "Actor",
    "category": "Object",
    "module": "Core",
    "includeExamples": true,
    "maxResults": 10
  }
}

输出示例：

{
  "results": [
    {
      "class": "AActor",
      "description": "Base class for all actors in the game",
      "module": "Core",
      "category": "Object",
      "syntax": "class AActor : public UObject",
      "examples": [
        "// Create a new actor\nAActor* MyActor = GetWorld()->SpawnActor<AActor>();"
      ],
      "remarks": [
        "Actors are the base building blocks of the game",
        "Can be placed in levels or spawned dynamically"
      ],
      "documentation": "https://dev.epicgames.com/documentation/en-us/unreal-engine/API/Core/AActor",
      "relevance": 100
    }
  ]
}

API文档查询工具提供：

  • 跨类文档的全文搜索
  • 按类别和模块筛选
  • 代码示例和使用模式
  • 基于相关性的结果排序
  • 官方文件链接

7.子系统分析

// Analyze the Physics subsystem
{
  "name": "analyze_subsystem",
  "arguments": {
    "subsystem": "Physics"
  }
}

输出示例：

{
  "name": "Physics",
  "coreClasses": [
    "UPhysicsEngine",
    "FPhysScene",
    "UBodySetup"
  ],
  "keyFeatures": [
    "PhysX integration",
    "Collision detection",
    "Physical materials"
  ],
  "commonUseCases": [
    "Character movement",
    "Vehicle simulation",
    "Destructible environments"
  ]
}

API文档

分析仪现在包括全面的API文档功能：

  1. 自动文档生成

    • 从源代码注释中提取文档
    • 分析类结构和关系
    • 按类型和模块对类进行分类
    • 生成语法示例和使用模式

  2. 智能搜索

    • 在所有文档中进行全文搜索
    • 基于相关性的结果排名
    • 类别和模块过滤
    • 代码示例包含

  3. 文档类别

    • 对象：基本对象类（UObject派生类）
    • Actor：Actor类（AActor导数）
    • 结构：数据结构和类型
    • 组件：组件类
    • 杂项：其他类别和公用事业

  4. 模块组织

    • 核心：核心引擎功能
    • RenderCore：渲染系统
    • 物理核心：物理引擎
    • 以及其他发动机模块

  5. 与现有工具集成

    • 链接到类分析以获取详细信息
    • 连接到模式检测以获取最佳实践
    • 参考虚幻引擎官方文档
    • 提供学习资源和示例

最佳实践

  1. 在使用分析工具之前，始终设置虚幻引擎路径或自定义代码库路径
  2. 分析时使用特定的类名（例如，“MyClass”而不仅仅是“class”）
  3. 在中利用文件模式参数 search_code 缩小结果范围
  4. 在分析类层次结构时包括已实现的接口，以便完全理解
  5. 在深入特定类之前，使用子系统分析工具获得高级概述（仅限虚幻引擎）

错误处理

在以下情况下，分析器将抛出明确的错误消息：

  • 未设置代码库路径（虚幻引擎或自定义）
  • 提供的路径不存在或无法访问
  • 在代码库中找不到类或符号
  • 提供的文件模式无效
  • 搜索查询或C++代码中的语法错误
  • 对源文件的访问受到限制
  • C++文件的树状图解析失败

性能注意事项

  • 大型代码库可能需要更长的时间来分析
  • 复杂的类层次结构可能需要更多的处理时间
  • 广泛的搜索模式可能会导致许多匹配
  • 考虑使用更具体的查询以获得更快的结果

测试

该项目包括对所有主要部件的全面测试：

测试覆盖率

  • 分析仪测试：UnrealCodeAnalyzer类的核心功能测试

    • 初始化和路径验证
    • 类分析和解析
    • 参考文献检索
    • 代码搜索
    • 子系统分析
    • 缓存管理

  • 游戏类型测试：游戏类型知识库的验证

    • 数据结构验证
    • 流派特定功能验证
    • 组件命名约定
    • 数据完整性检查

  • MCP服务器测试：MCP服务器实施测试

    • 服务器初始化
    • 工具登记和处理
    • 请求/响应验证
    • 错误处理
    • 工具特定功能测试

运行测试

运行所有测试：

npm test

在监视模式下运行测试（在开发过程中很有用）：

npm run test:watch

写作测试

在贡献新功能时，请确保：

  1. 所有新功能都有相应的测试覆盖率
  2. 测试在 src/__tests__ 目录
  3. 适当地模拟外部依赖关系
  4. 遵循现有的测试模式以保持一致性

贡献

欢迎投稿！请随时提交拉取请求，并对以下内容进行改进：

  • 源代码解析能力
  • 新的分析功能
  • 性能优化
  • 文档改进
  • 测试覆盖率

在提交PR之前：

  1. 确保所有测试通过(npm test)
  2. 添加新功能的测试
  3. 根据需要更新文档

相关 MCP