Unity API Documentation

unity-api-mcp

为 AI Agent 提供准确 Unity API 文档的 MCP 服务，可避免虚构签名、错误命名空间和使用已弃用 API。

支持 Unity 6（每个次要版本系列对应一个数据库）、Unity 2023 和 Unity 2022 LTS。可与 Claude Code、Cursor、Windsurf 或任何兼容 MCP 的 AI 工具搭配使用。无需安装 Unity。请参阅支持的版本。系统每周自动检测并构建新的 Unity 版本。

快速开始

将以下内容添加到 MCP 配置（.mcp.json、mcp.json 或工具的 MCP 设置）中，并将 UNITY_VERSION 设置为与项目匹配的版本：

{
  "mcpServers": {
    "unity-api": {
      "command": "uvx",
      "args": ["unity-api-mcp"],
      "env": {
        "UNITY_VERSION": "6000.3"
      }
    }
  }
}

有效值：Unity 6 系列版本，例如 "6000.3"，或 "6"、"2023"、"2022"。

首次运行时，服务会将相应的数据库（约 20-30 MB）下载到 ~/.unity-api-mcp/。

工作原理

1. 版本检测。 服务会确定要提供哪个 Unity 版本：

2. 下载数据库。 如果本地尚未缓存该版本的数据库，服务会从 GitHub 下载。Unity 6 的次要版本系列（6000.0、6000.3、6000.5……）各自有独立数据库；如果某个系列的数据库尚未发布，则回退到通用的 6 数据库。服务启动时会检查缓存数据库是否为最新版本，因此每周重新构建的数据库会自动更新到现有安装中。

3. 提供服务。 所有工具调用都会查询对应版本的 SQLite 数据库。每次查询耗时均少于 15 毫秒。

每个版本都有独立的数据库，其中包含该版本对应的准确签名、弃用警告和成员列表。

工具

覆盖范围

涵盖所有 UnityEngine 和 UnityEditor 模块，以及从 C# 源代码解析的包：Input System、Addressables、uGUI（Unity 6 中包括 TextMeshPro）、AI Navigation 和 Netcode。每个 Unity 6 数据库约有 42,500 条记录，以及约 500 条弃用警告。

完整版本列表：db-v1 发布页面。CI 会在每次构建时重新生成该表。每周一会自动检测并构建新的 Unity 补丁版本。

不涵盖第三方资源（DOTween、VContainer、Newtonsoft.Json）。对于这些资源，请依赖项目源代码。

基准测试

这些是实测结果，而非承诺：在 3 个测试环境中提出 25 个研究问题，由 3 种 Agent 配置作答，并将每个答案与事先在源代码中核实的真实答案进行对照评判。完整的测试框架位于 docs/benchmark/，可通过一条命令重新运行。

这次复现出的幻觉很有启发性。当被要求列出 SceneManager.LoadSceneAsync 的重载时，两个未使用 MCP 的 Agent 都虚构了不存在的单参数 LoadSceneAsync(string) 和 LoadSceneAsync(int) 重载。基于这些重载编写的代码无法编译。MCP Agent 则给出了准确的 4 个真实重载。

为什么关注正确性，而不是节省 token？如今 Agent 工具已经很擅长搜索代码。Claude Code 从一开始就提供了 Grep 工具，而当前的模型会先搜索，再读取较窄的行范围，因此我们测试中所有配置的 token 用量大致相当。但确切的重载、命名空间和弃用信息根本不在项目文件中。没有 MCP 的 Agent 只能根据用法示例推断；一旦推断错误，你就得为构建失败买单。

CLAUDE.md 片段

将以下内容添加到项目的 CLAUDE.md（或同等的指令文件）中。**这一步很重要。**没有这段内容，AI 虽然拥有这些工具，却不知道何时该使用它们。

## Unity API Lookup (unity-api MCP)

Use the `unity-api` MCP tools to verify Unity API usage instead of guessing. **Do not hallucinate signatures.**

| When | Tool | Example |
|------|------|---------|
| Unsure about a method's parameters or return type | `get_method_signature` | `get_method_signature("UnityEngine.Tilemaps.Tilemap.SetTile")` |
| Need the `using` directive for a type | `get_namespace` | `get_namespace("SceneManager")` |
| Want to see all members on a class | `get_class_reference` | `get_class_reference("InputAction")` |
| Searching for an API by keyword | `search_unity_api` | `search_unity_api("async load scene")` |
| Checking if an API is deprecated | `get_deprecation_warnings` | `get_deprecation_warnings("FindObjectOfType")` |

**Rules:**
- Before writing a Unity API call you haven't used in this conversation, verify the signature with `get_method_signature`
- Before adding a `using` directive, verify with `get_namespace` if unsure
- Covers: all UnityEngine/UnityEditor modules, Input System, Addressables, uGUI/TextMeshPro, AI Navigation, Netcode
- Does NOT cover: DOTween, VContainer, Newtonsoft.Json (third-party)

设置详情

{
  "mcpServers": {
    "unity-api": {
      "command": "uvx",
      "args": ["unity-api-mcp"],
      "env": {
        "UNITY_PROJECT_PATH": "/path/to/your/unity-project"
      }
    }
  }
}

pip install unity-api-mcp

{
  "mcpServers": {
    "unity-api": {
      "command": "unity-api-mcp",
      "args": [],
      "env": {
        "UNITY_VERSION": "6000.3"
      }
    }
  }
}

# Install with ingest dependencies
pip install unity-api-mcp[ingest]

# Windows
python -m unity_api_mcp.ingest --unity-version 6000.3 --unity-install "D:/Unity/6000.3.8f1" --project "F:/Unity Projects/MyProject"

# macOS
python -m unity_api_mcp.ingest --unity-version 6000.3 --unity-install "/Applications/Unity/Hub/Editor/6000.3.20f1" --project "/path/to/UnityProject"

# Legacy versions
python -m unity_api_mcp.ingest --unity-version 2022 --unity-install "D:/Unity/2022.3.62f1"

unity-api-mcp/
├── src/unity_api_mcp/
│   ├── server.py          # MCP server (5 tools)
│   ├── db.py              # SQLite + FTS5 database layer
│   ├── version.py         # Version detection + DB download
│   ├── xml_parser.py      # Parse Unity XML IntelliSense files
│   ├── cs_doc_parser.py   # Parse C# doc comments from package source
│   ├── unity_paths.py     # Locate Unity install + package dirs
│   └── ingest.py          # CLI ingestion pipeline
└── pyproject.toml

故障排除

另请参阅

unreal-api-mcp：Unreal Engine（C++）的同类工具，按 UE 版本每周自动构建数据库。

联系方式

需要为你的引擎或框架定制 MCP 服务吗？我会构建 MCP 工具，减少 Token 浪费，并避免 AI 辅助游戏开发中的幻觉。如果你想为团队的技术栈构建类似工具，欢迎联系我。

[email protected]

许可证

MIT