Unity API Documentation MCP Server

Accurate Unity API docs (2022/2023/6) for AI agents. Prevents hallucinated signatures.

Local serverstdioPython

What is the Unity API Documentation MCP server?

Connect Unity API Documentation to Claude, Cursor or any other MCP client and it stops being a tab you switch to. Accurate Unity API docs (2022/2023/6) for AI agents. Prevents hallucinated signatures. The unity api documentation mcp server is what makes that connection.

What the server does

Supports Unity 6 (one database per minor stream), Unity 2023, and Unity 2022 LTS. Works with Claude Code, Cursor, Windsurf, or any MCP-compatible AI tool. No Unity installation required. See the supported versions. New Unity releases are detected and built automatically every week.

Available tools

The toolset is worth reading before you wire it up, because it tells you what the integration is really for:

  • Covers — all UnityEngine/UnityEditor modules, Input System, Addressables, uGUI/TextMeshPro, AI Navigation, Netcode
  • search_unity_api — Find APIs by keyword
  • get_method_signature — Exact signatures with all overloads
  • get_namespace — Resolve using directives
  • get_class_reference — Full class reference card
  • get_deprecation_warnings — Check if an API is obsolete
  • When — Tool

Installation

unity-api-mcp on PyPI is all you need. Most clients run it directly, so configuration is a few lines and a restart.

Credentials and setup notes

Configuration is passed through the environment: UNITY_VERSION, UNITY_PROJECT_PATH, UNITY_INSTALL_PATH. Treat anything key-shaped as a real credential — scope it to the minimum the server needs, and rotate it if it ever lands in a shared config.

Where it fits

Among the knowledge and memory options, the useful question is rarely "what can it do" but "what does it cost you to run" — permissions, credentials, and how much of your context its toolset consumes. Unity API Documentation's toolset — Covers, search_unity_api, get_method_signature and 4 more — is a fair guide to whether it matches your workflow. It is maintained by Codeturion; worth a glance at recent repository activity before you build anything load-bearing on it.

SyncDev reviews every entry in this directory against the project's own documentation before publishing, and revisits them as servers change.

Worth knowing first

  • It runs with your machine's permissions. That is convenient and also the reason to think about what you point it at before you approve a tool call.
  • Keep per-call confirmation enabled while you learn its behaviour; it is the cheapest safeguard you have.

Available tools

ToolWhat it does
Coversall UnityEngine/UnityEditor modules, Input System, Addressables, uGUI/TextMeshPro, AI Navigation, Netcode
search_unity_apiFind APIs by keyword
get_method_signatureExact signatures with all overloads
get_namespaceResolve using directives
get_class_referenceFull class reference card
get_deprecation_warningsCheck if an API is obsolete
WhenTool

How to install the Unity API Documentation MCP server

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

Configuration as documented by the project. Restart the client after saving.

Configuration

VariableDescriptionRequired
UNITY_VERSIONConfiguration value read at startup.Optional
UNITY_PROJECT_PATHFilesystem location the server is allowed to use.Optional
UNITY_INSTALL_PATHFilesystem location the server is allowed to use.Optional

Example prompts to try

  • Use Unity API Documentation to Covers.
  • Use Unity API Documentation to search unity api.
  • Use Unity API Documentation to get method signature.

Frequently asked questions

It connects Unity API Documentation to MCP-compatible AI assistants such as Claude and Cursor, exposing 7 tools (Covers, search_unity_api, get_method_signature, and more) that the assistant can call on your behalf. Instead of copying data back and forth by hand, the assistant works with Unity API Documentation directly.