Unity API
Instant, accurate Unity API lookups instead of expensive source file reads, saving your agent tokens, context, and hallucinations
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
Maintainer
Works with
Installation
PIP
pip install unity-api-mcpManual Installation
pip install unity-api-mcpConfiguration
Configuration Details
claude_desktop_config.json
Performance
Response Metrics
Resource Usage
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
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-mcpOpen your MCP client configuration
For Claude Code open ~/.claude/settings.json or your project's .mcp.json. For Cursor open its MCP settings file.
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"
}
}
}
}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.
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.
Unity API Alternatives — Similar Developer Tools Servers
Looking for alternatives to Unity API? Here are other popular developer tools servers you can use with Claude, Cursor, and VS Code.
Ecc
★ 188.2kThe agent harness performance optimization system. Skills, instincts, memory, security, and research-first development for Claude Code, Codex, Opencode, Cursor and beyond.
Javaguide
★ 155.8kJava 面试 & 后端通用面试指南,覆盖计算机基础、数据库、分布式、高并发、系统设计与 AI 应用开发
Gemini CLI
★ 104.5kA secure MCP server that wraps the Google Gemini CLI, allowing clients to query Gemini models using local OAuth sessions without requiring an API key. It provides tools for model interaction and diagnostics with built-in protection against command in
Awesome MCP Servers
★ 87.3k⭐ Curated list of Model Context Protocol (MCP) servers - tools that extend Claude Desktop, Cursor, Windsurf, and other MCP clients with custom capabilities.
MCP Servers
★ 86.0kModel Context Protocol Servers
CC Switch
★ 77.5kA cross-platform desktop All-in-One assistant for Claude Code, Codex, OpenCode, OpenClaw, Gemini CLI & Hermes Agent. Only official website: ccswitch.io
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.
Set Up Unity API in Your Editor
Choose your AI client for step-by-step setup instructions.
Quick Config Preview
Add this to your claude_desktop_config.json or .cursor/mcp.json
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.