Unity API

v2.0.2Developer Toolsstable

Instant, accurate Unity API lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations

aiapi-documentationclaudecursorgame-development
Share:
58
Stars
0
Downloads
0
Weekly
0/5

What is Unity API?

Unity API is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to instant, accurate unity api lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations

Instant, accurate Unity API lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations

This server falls under the Developer Tools category on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • Instant, accurate Unity API lookups instead of expensive sou

Use Cases

Game development with AI-assisted API lookups
Token-efficient Unity development context
Codeturion

Maintainer

LicenseNOASSERTION
Languagepython
Versionv2.0.2
UpdatedMay 21, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

PIP

pip install unity-api-mcp

Manual Installation

pip install unity-api-mcp

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use Unity API

The Unity API MCP Server provides instant, accurate lookups of the Unity scripting API without requiring the AI to read large source files or hallucinate method signatures. It indexes the official Unity documentation for versions 2022, 2023, and 6, storing it in a compact local database so queries return in milliseconds. Game developers using Claude Code, Cursor, or other AI coding tools use it to resolve class references, check deprecation warnings, and look up correct method overloads while keeping token usage low.

Prerequisites

  • Python 3.10 or later (for pip install) or uv installed (for uvx)
  • An MCP-compatible client such as Claude Code or Cursor
  • Internet access on first run to download the API database (~18-24 MB per Unity version)
  • Optionally, a local Unity installation if you want to build the database yourself with the ingest tool
1

Install unity-api-mcp

Install via pip or use uvx for isolated execution. The ingest extra is only needed if you want to build the local database from a Unity installation rather than downloading it.

pip install unity-api-mcp
# or for uvx (no install needed, runs inline):
# uvx unity-api-mcp
2

Open your MCP client configuration

For Claude Code open ~/.claude/settings.json or your project's .mcp.json. For Cursor open its MCP settings file.

3

Add the unity-api server entry

Set UNITY_VERSION to the major version you are targeting: '2022', '2023', or '6'. The database for that version is downloaded automatically to ~/.unity-api-mcp/ on first use.

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

Restart your MCP client

Reload Claude Code or Cursor to activate the server. On the first request the database download will occur in the background—this may take a few seconds.

5

Optionally detect the Unity version from your project

Instead of hardcoding UNITY_VERSION, set UNITY_PROJECT_PATH to your Unity project root and the server will read the ProjectSettings/ProjectVersion.txt file to determine the correct version automatically.

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

Unity API Examples

Client configuration

MCP config targeting Unity 2022 using uvx for dependency-isolated execution.

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

Prompts to try

Example requests that exercise the search_unity_api, get_method_signature, get_namespace, get_class_reference, and get_deprecation_warnings tools.

- "What is the exact signature of Rigidbody.AddForce in Unity 2022?"
- "Which namespace do I need to import to use NavMeshAgent?"
- "Show me the full class reference for Physics2D including all methods and properties"
- "Is Transform.localScale deprecated in Unity 6 and what should I use instead?"
- "Search the Unity API for methods related to input handling in Unity 2023"
- "Get all overloads of GameObject.GetComponent and explain when to use each"

Troubleshooting Unity API

Database download fails or times out on first run

The server downloads the API database (~18-24 MB) from GitHub releases on first use. Ensure you have an internet connection. If behind a proxy, set the HTTPS_PROXY environment variable. You can also build the database locally with: python -m unity_api_mcp.ingest --unity-version 2022 --unity-install /path/to/unity

UNITY_VERSION not recognised or wrong docs returned

Valid values are '2022', '2023', or '6'. Full version strings like '6000.3.8f1' are also accepted. If you use UNITY_PROJECT_PATH instead, make sure the path points to the project root containing ProjectSettings/ProjectVersion.txt.

uvx command not found

uvx is part of the uv package manager. Install it with: curl -LsSf https://astral.sh/uv/install.sh | sh (macOS/Linux) or follow the uv installation guide for Windows. Alternatively use the pip install unity-api-mcp approach and set the command to 'unity-api-mcp' in your config.

Frequently Asked Questions about Unity API

What is Unity API?

Unity API is a Model Context Protocol (MCP) server that instant, accurate unity api lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations It connects AI assistants to external tools and data sources through a standardized interface.

How do I install Unity API?

Install via pip with: pip install unity-api-mcp. Then configure your AI client to connect to this MCP server.

Which AI clients work with Unity API?

Unity API works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is Unity API free to use?

Yes, Unity API is open source and available under the NOASSERTION license. You can use it freely in both personal and commercial projects.

Browse More Developer Tools MCP Servers

Explore all developer tools servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "unity-api": { "command": "pip", "args": ["install", "unity-api-mcp"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide →

Ready to use Unity API?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides