Unity-MCP项目中脚本查看功能的超时问题分析与解决方案

问题背景

在Unity-MCP项目使用过程中，开发者报告了一个关于VIEW_SCRIPT命令执行时出现的超时问题。该问题表现为当尝试查看某些特定脚本文件时，系统会进入超时循环，最终导致连接中断。值得注意的是，该问题并非在所有脚本上都会出现，而是具有选择性。

问题现象分析

从日志中可以观察到几个关键现象：

1. 系统在尝试读取Assets/Scripts/ScoreManager.cs文件时出现超时
2. 超时后系统不断重试资源列表请求
3. 最终连接因超时过多而被关闭
4. 某些情况下会出现路径格式错误，如Assets/Assets\Scripts/SimpleInteraction.cs这样的混合路径格式

根本原因

经过深入分析，发现该问题主要由两个因素导致：

1. 路径处理不一致：Unity返回的路径格式与MCP期望的格式不匹配。Unity使用反斜杠(\)作为路径分隔符，而MCP期望使用正斜杠(/)。这种不一致导致文件查找失败。

2. 特殊字符处理：包含特殊字符(如引号)的脚本内容可能导致JSON解析失败。当脚本中包含大量字符串字面量和插值字符串时，可能干扰JSON格式的完整性。

3. 超时机制缺陷：当前系统在遇到第一个超时后，没有正确处理后续请求，导致级联失败。

解决方案

针对上述问题，我们实施了以下改进措施：

1. 路径规范化处理：

   • 在MCP端添加路径规范化函数
   • 自动将反斜杠转换为正斜杠
   • 移除重复的路径前缀(如Assets/Assets)

2. 内容安全传输：

   • 对脚本内容进行Base64编码传输
   • 在解码端添加严格的错误处理
   • 实现内容验证机制

3. 超时处理优化：

   • 增加超时重试机制
   • 设置最大重试次数
   • 改进错误反馈信息

实现细节

在具体实现上，我们主要修改了以下几个关键部分：

1. 路径处理模块：

public static string NormalizePath(string path)
{
    // 统一路径分隔符
    path = path.Replace('\\', '/');
    
    // 处理重复前缀
    if(path.StartsWith("Assets/Assets/"))
    {
        path = path.Substring(7);
    }
    
    return path;
}

2. 内容编码模块：

def encode_script_content(content):
    try:
        # 尝试直接JSON序列化
        json.dumps({'content': content})
        return content
    except:
        # 如果失败则使用Base64编码
        return base64.b64encode(content.encode('utf-8')).decode('utf-8')

3. 超时处理策略：
   • 首次超时：等待2秒后重试
   • 第二次超时：等待5秒后重试
   • 第三次超时：终止请求并返回详细错误

验证与测试

为确保修复效果，我们设计了以下测试用例：

1. 路径测试：

   • 输入Assets\Scripts\Test.cs → 期望输出Assets/Scripts/Test.cs
   • 输入Assets/Assets\Scripts/Test.cs → 期望输出Assets/Scripts/Test.cs

2. 内容测试：

   • 包含大量引号的脚本文件
   • 包含特殊字符的脚本文件
   • 大文件(>1MB)传输测试

3. 超时测试：

   • 模拟慢速响应
   • 模拟无响应
   • 模拟间歇性响应

最佳实践建议

基于此次问题的解决经验，我们建议开发者在类似场景中：

1. 始终对跨平台路径进行规范化处理
2. 对传输内容实施防御性编码策略
3. 实现完善的超时和重试机制
4. 添加详细的错误日志记录
5. 进行边界条件测试

总结

Unity-MCP项目中的脚本查看功能超时问题揭示了在跨系统通信中几个关键的设计考量点。通过规范化路径处理、安全内容传输和健壮的错误处理机制，我们不仅解决了当前问题，还为系统建立了更可靠的通信基础。这些改进使得MCP协议在Unity环境中的集成更加稳定可靠。