# Unity API Documentation MCP server

> Gives AI clients accurate Unity API signatures, namespaces, class references, and deprecation warnings for Unity 2022, 2023, and 6.

- Repository: https://github.com/Codeturion/unity-api-mcp
- Page: https://hostedmcp.org/servers/codeturion/unity-api-mcp
- Transport: stdio
- Stars: 66
- License: MIT
- Latest version: 2.1.1

## Install

### Claude Code

```sh
claude mcp add unity-api-mcp -- uvx unity-api-mcp
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "unity-api-mcp": {
      "command": "uvx",
      "args": [
        "unity-api-mcp"
      ]
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "unity-api-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "unity-api-mcp"
      ]
    }
  }
}
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "unity-api-mcp": {
      "command": "uvx",
      "args": [
        "unity-api-mcp"
      ]
    }
  }
}
```

### Codex (`~/.codex/config.toml`)

```toml
[mcp_servers.unity-api-mcp]
command = "uvx"
args = ["unity-api-mcp"]
```

### Gemini CLI (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "unity-api-mcp": {
      "command": "uvx",
      "args": [
        "unity-api-mcp"
      ]
    }
  }
}
```

## Environment variables

| Name | Required | Secret | Description |
|---|---|---|---|
| `UNITY_PROJECT_PATH` | no | no | Path to Unity project for auto-detecting version from ProjectSettings/ProjectVersion.txt |
| `UNITY_VERSION` | no | no | Unity version to serve: 2022, 2023, or 6 (default: auto-detect or 6) |

## Tools (5)

- `search_unity_api`
- `get_method_signature`
- `get_namespace`
- `get_class_reference`
- `get_deprecation_warnings`

## FAQ

### Which Unity versions does this MCP server support?

It supports Unity 6 (one database per minor stream), Unity 2023, and Unity 2022 LTS.

### How do I check the exact signature of a Unity method?

Use the get_method_signature tool, which returns exact signatures with all overloads.

### How do I find the using directive for a Unity type?

Call get_namespace with the type name to resolve the correct using directive.

### Does it tell me if a Unity API is deprecated?

Yes, get_deprecation_warnings checks whether an API is obsolete and suggests replacements.

### Does it cover third-party Unity assets like DOTween?

No, third-party assets such as DOTween, VContainer, and Newtonsoft.Json are not indexed.