Unity API Documentation MCP Server

社区

为 AI 代理提供准确的 Unity API 文档，杜绝伪造签名

分类: 开发工具第 133 / 438
Stars: ★ 67 热门
传输方式: stdio（本地进程）
运行环境: Python 3.10+
凭据: 无需凭据
许可证: MIT
最近提交: 13 天前
工具数: 5

59FMRS · C

这是一个面向 Unity 开发者的第三方 MCP 服务器，通过按版本索引的 SQLite 数据库为 AI 代理提供准确的 Unity API 文档，包括方法签名、重载、命名空间和废弃警告。README 中给出的基准测试显示，使用该 MCP 的配置在 25 道题中答对 24 道且零幻觉，明显优于仅使用 Grep/Read 的配置。它支持 Unity 6、2023 和 2022 LTS，兼容 Claude Code、Cursor 和 Windsurf，无需安装 Unity，数据库每周自动重建。局限在于不覆盖第三方资源，且首次使用需要联网下载数据库。适合希望减少 AI 幻觉、提升代码可编译性的 Unity 团队。

最强项 · 文档质量 14/20 最弱项 · 可靠性 9/20

可靠性

9/20

安全与权限

11/20

维护活跃度

12/20

文档质量

14/20

安装易用性

13/20

查看各项评分依据

可靠性 9/20: 静态材料仅含 server.json、README 与项目结构说明，未提供任何可验证的执行证据（无提交的测试文件、无真实 CI 工作流内容）。服务器声明的 5 个工具（search_unity_api、get_method_signature、get_namespace、get_class_reference、get_deprecation_warnings）与 README 描述一致，未见明显矛盾；首次运行需从 GitHub 下载 20-30MB SQLite 数据库，属外部依赖且失败路径仅以故障排查表格笼统提及（“检查网络”），错误处理细节不可验证。README 提到每周一自动构建与数据库新鲜度检查，但无工作流文件佐证。按静态校准规则，可靠性不得超过 12；因缺少测试与 CI 证据，扣分至 9。
安全与权限 11/20: 未发现恶意、凭据窃取、隐蔽外传等红线行为，故不触发 0-4 区间。但静态证据有限：工具默认将数据库从 GitHub 下载到 ~/.unity-api-mcp/ 并写入本地文件系统，属未加确认的可写副作用；联网下载未在清单中声明任何校验机制（哈希或签名），存在供应链风险但未见实际利用证据。环境变量 UNITY_VERSION/UNITY_PROJECT_PATH 均标为非机密，处理得当；UNITY_PROJECT_PATH 仅读取 ProjectSettings/ProjectVersion.txt，权限范围克制。整体主要风险可见而确认与完整性校验不完整，给 11。
维护活跃度 12/20: MIT 许可证明确，版本号 2.0.2 与 server.json 一致，README 显示有 PyPI 发布徽章、每周一自动检测 Unity 新版本的构建流程及 db-v1 发布页，另有关联项目 unreal-api-mcp，表明持续维护与清晰归属。但为静态评审，未见实际提交历史、issue 响应记录、依赖更新策略或安全响应渠道说明；7 个未关闭 issue 无法核验处理时效。治理与版本化存在信息缺口，故给 12。
文档质量 14/20: 文档分层良好：快速开始、版本检测优先级表、5 个工具用途与调用示例、覆盖范围与明确不覆盖项（DOTween、VContainer、Newtonsoft.Json）、故障排查表、环境变量表、多平台本地建库命令、基准测试方法与可重跑脚本说明。显著优点是对局限与成本（首次下载 20-30MB、每版本独立数据库）有披露。扣分点：基准测试图表以外部图片引用无法核验，所谓“Measured, not promised”属自述证据；工具参数未给完整 schema（输入/输出格式、错误返回）；README 含针对 AI 代理的指令性内容，按证据规则不作为可信依据。综合给 14。
安装易用性 13/20: 安装路径清晰且步骤少：uvx 一行命令加 MCP 配置 JSON 示例，给出 Claude Code/Cursor/Windsurf 等主流客户端配置片段，并提供 pip 安装与 UNITY_PROJECT_PATH 自动检测版本两种替代方案，另有 AI 辅助安装提示。平台覆盖提到 Windows 与 macOS。扣分点：首次运行需联网下载数据库，离线环境需自行构建并安装 ingest 额外依赖，属较脆弱环节；Python 3.10+ 前置条件在故障排查中提及但未在快速开始前强调；未验证客户端实际握手连通性。按静态校准上限 15，故给 13。

静态评测 · 未实际运行收录于 2026-09-10

查看 FMRS 评分方法 →

选型与风险

能访问什么访问网络连接数据库

适合谁

使用 Claude Code、Cursor 或 Windsurf 开发 Unity 项目的团队
需要避免 AI 生成虚假 Unity API 签名的开发者
支持 Unity 6、Unity 2023 或 Unity 2022 LTS 的项目
希望减少源代码读取、节省上下文与 token 的 AI 辅助工作流

不适合谁

需要查询 DOTween、VContainer、Newtonsoft.Json 等第三方资源的用户（不在索引范围内）
使用 Unreal Engine 或其他非 Unity 引擎的开发者
Python 版本低于 3.10 的环境
需要官方 Unity 支持的场景（本项目为独立第三方项目）

所需权限

读取本地 MCP 配置文件的权限
首次运行时访问网络下载数据库（约 20-30 MB）
读写 ~/.unity-api-mcp/ 目录以缓存数据库
可选的 UNITY_PROJECT_PATH 会读取项目下的 ProjectSettings/ProjectVersion.txt
可选的 UNITY_INSTALL_PATH 仅在本地构建数据库（ingest）时用于定位 Unity 安装路径

风险与副作用

首次运行或数据库更新需要网络访问，无法联网时需本地构建数据库
下载的数据库约 20-30 MB，会占用本地磁盘空间
环境变量 UNITY_VERSION 设置错误可能导致返回错误版本的 API 文档
数据库由 CI 每周自动重建，版本覆盖可能与最新 Unity 发布存在时间差
第三方资源不在索引中，查询这些包会返回空结果

安装接入

准备工作

运行环境：Python 3.10+

其他可选配置项（3 个）

UNITY_VERSION 可选要服务的 Unity 版本（如 6000.3、6、2023、2022），可从项目 ProjectSettings/ProjectVersion.txt 确定，缺省为 6。

UNITY_PROJECT_PATH 可选 Unity 项目路径，服务器会自动读取 ProjectSettings/ProjectVersion.txt 检测版本，非必填。

UNITY_INSTALL_PATH 可选覆盖 Unity 安装路径，仅本地构建数据库（ingest）时使用。

在 MCP 配置文件中（如 .mcp.json、mcp.json 或工具的 MCP 设置）添加服务器配置：使用 uvx 运行 unity-api-mcp，并将 UNITY_VERSION 设置为与项目匹配的值（如 "6000.3"、"6"、"2023" 或 "2022"）。
也可用 pip install unity-api-mcp 安装，然后在配置中将 command 设为 unity-api-mcp。
若不设置 UNITY_VERSION，可设置 UNITY_PROJECT_PATH 指向 Unity 项目路径，服务器会读取 ProjectSettings/ProjectVersion.txt 自动检测版本；两者都未设置时默认使用 "6"。
首次运行时服务器会自动下载对应版本的数据库（约 20-30 MB）到 ~/.unity-api-mcp/。
在项目的 CLAUDE.md 或等效的指令文件中添加 README 提供的使用说明片段，帮助 AI 知道何时调用这些工具。

.mcp.json

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

以 Claude Code 为例。其他客户端的配置文件位置或字段可能不同（如 VS Code 使用 servers 字段），可用下方配置生成器转换。

.vscode/mcp.json

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

写入项目的 .vscode/mcp.json（VS Code 使用 servers 字段）。

Terminal

claude mcp add unity-api -e UNITY_VERSION=6000.3 -- uvx unity-api-mcp

在终端运行；先把 <…> 占位符换成你自己的值。

生成并校验客户端配置

验证是否装好

连接后在客户端工具列表中应出现 search_unity_api 等 5 个 unity-api 工具；调用 get_namespace("SceneManager") 若返回 using UnityEngine.SceneManagement; 即说明安装成功。

常见排障

若提示“Could not download Unity X database”，检查网络连接，或使用 python -m unity_api_mcp.ingest --unity-version 2022 在本地构建数据库
若服务的 API 版本不正确，显式设置 UNITY_VERSION，并通过 stderr 输出“unity-api-mcp: serving Unity <version> API docs”确认
若服务器无法启动，检查 python --version 是否为 3.10+，并用 which unity-api-mcp 或 where unity-api-mcp 检查路径
若第三方包查询没有结果，属于预期行为：DOTween、VContainer、Newtonsoft.Json 未被索引
若 AI 不调用这些工具，检查是否已按 README 在 CLAUDE.md 中添加使用说明片段

试试这样问

连接成功后，可以直接对 AI 助手这样说：

用 get_method_signature 查一下 UnityEngine.Physics.Raycast 的完整签名和所有重载
SceneManager 应该写在哪个 using 指令里？用 get_namespace 确认一下
帮我检查 WWW 这个 API 是否已废弃，该用什么替代
用 search_unity_api 搜一下异步加载场景相关的 API

工具能力 5

search_unity_api 只读

按关键词查找 API，例如“Tilemap SetTile”“async load scene”

get_method_signature 只读

获取精确的方法签名及全部重载，例如 UnityEngine.Physics.Raycast

get_namespace 只读

解析 using 指令，例如“SceneManager”对应 using UnityEngine.SceneManagement;

get_class_reference 只读

获取完整的类参考卡片，例如“InputAction”的全部方法、字段和属性

get_deprecation_warnings 只读

检查 API 是否已废弃，例如“WWW”应改用 UnityWebRequest

使用场景

在编写 Unity API 调用前验证方法签名，避免猜测出错

查询类型的命名空间，正确添加 using 指令

查看类的全部成员（方法、字段、属性）

检查某个 Unity API 是否已被废弃及替代方案

让 AI 代理在 Unity 项目中生成可编译的代码

支持客户端

Claude Code

Cursor

Windsurf

依据项目文档列出，未经本站实测。

详细介绍

这是一个 MCP 服务器，为 AI 代理提供准确的 Unity API 文档，防止出现伪造的方法签名、错误的命名空间以及已废弃 API 的误用。它支持 Unity 6（每个次要版本流一个数据库）、Unity 2023 和 Unity 2022 LTS，可与 Claude Code、Cursor、Windsurf 或任何兼容 MCP 的 AI 工具配合使用。使用时无需安装 Unity。服务器首次运行时会自动下载对应版本的 SQLite 数据库（约 20-30 MB）到 ~/.unity-api-mcp/ 目录，所有工具调用均查询该版本专属数据库，每次查询在 15 毫秒内返回结果。数据库每周自动重建，以覆盖新的 Unity 版本。该项目不覆盖第三方资源（如 DOTween、VContainer、Newtonsoft.Json）。