沉浸式Web SDK模型上下文协议服务器

一个基于RAG技术的沉浸式Web SDK开发工具,提供文档查询、代码生成、验证和故障排除等功能。

  • by axe-work
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 nparashuram/iwsdk-mcp

使用说明

IWSDK MCP服务器

基于RAG的模型上下文协议服务器,用于沉浸式Web SDK开发

设置

准备RAG系统

# Clone the IWSDK repository (if you don't have it)
git clone https://github.com/meta-quest/immersive-web-sdk.git

# Prepare the RAG system (single command)
npm run prepare /path/to/immersive-web-sdk

该命令通过以下方式准备完整的RAG(检索增强生成)系统:

  1. 摄取IWSDK源代码 -从SDK中提取组件、系统、类型和示例
  2. 获取官方文件 -从Meta的开发者门户下载IWSDK官方文档
  3. 建设项目 -将TypeScript编译为JavaScript

遥测

MCP服务器自动将所有工具调用记录到 telemetry.jsonl 用于使用跟踪和调试。每行包含:

  • timestamp -ISO 8601时间戳
  • tool -调用的工具名称
  • params -传递给工具的参数(长字符串截断为500个字符)

遥测文件通过从git中排除 .gitignore.

遥测输入示例:

{
  "timestamp": "2025-11-15T21:18:25.883Z",
  "tool": "get_component_schema",
  "params": { "componentName": "OneHandGrabbable" }
}

配置

跑完后 npm run prepare,在客户端中配置MCP服务器:

{
  "mcpServers": {
    "iwsdk": {
      "command": "node",
      "args": ["/absolute/path/to/iwsdk-mcp/build/index.js"]
    }
  }
}

工具

MCP服务器提供18种按类别组织的工具:

文件和参考:

  • get_api_documentation -查询API文档中的类/方法
  • get_component_schema -使用JSDoc、需求和关系获取组件字段定义
  • get_system_info -获取包含方法、属性和查询组件的系统文档
  • search_code_examples -查找相关代码示例
  • explain_concept -获取IWSDK概念的解释
  • lookup_package_exports -列出包中的所有导出

代码生成:

  • generate_system_template -为自定义ECS系统生成样板
  • scaffold_project -生成完整的项目结构
  • compose_feature -使用所有必要的组件/系统编写完整的功能实现
  • find_similar_code -通过描述查找类似的代码示例

验证和故障排除:

  • validate_code -根据最佳实践验证代码,并检测缺失的组件/系统
  • get_validation_rules -获取组件/系统的验证规则
  • check_component_order -检查正确的组件订购约束
  • get_common_mistakes -使用错误/正确的代码示例搜索常见错误

实施指南:

  • find_implementation_pattern -获取常见功能的实施指南
  • get_setup_guide -获取项目设置说明
  • explain_asset_pipeline -获取资产处理指导
  • get_best_practices -获取推荐图案和反图案
  • troubleshoot_error -获取错误诊断步骤