Unity MCP Server (npm package)

MCP (Model Context Protocol) server for Unity Editor integration.
Enables AI assistants like Claude and Cursor to interact directly with Unity Editor for automated workflows.

This README documents the npm package.
For the Unity package, OpenUPM setup, and the full repository documentation, see:

- github.com/akiojin/unity-mcp-server

Quick Start

$3

``bash
npx @akiojin/unity-mcp-server@latest
`

$3

`bash
npx @akiojin/unity-mcp-server@latest --http 6401 --no-telemetry
curl http://localhost:6401/healthz
`

Unity Setup

1. Install the Unity package from:
- https://github.com/akiojin/unity-mcp-server.git?path=UnityMCPServer/Packages/unity-mcp-server
2. Open Unity Package Manager → Add package from git URL
3. The package starts a TCP server (default port 6400)

MCP Client Configuration

$3

Add to your claude_desktop_config.json:

`json
{
"mcpServers": {
"unity-mcp-server": {
"command": "npx",
"args": ["@akiojin/unity-mcp-server@latest"]
}
}
}
`

Tools & Discovery

Unity MCP Server ships 100+ tools.
Use the search_tools meta-tool to find the right tool quickly.

`json
{
"tool": "search_tools",
"params": {
"query": "create gameobject",
"limit": 10
}
}
`

More details:

- Tools & Code Index workflow: docs/tools.md
- Configuration reference: docs/configuration.md

Requirements

- Unity 2020.3 LTS or newer
- Node.js 18.x / 20.x / 22.x LTS (23+ not supported)
- MCP client (Claude Desktop, Cursor, etc.)

Native SQLite preload (optional)

The server uses fast-sql, which can preload a native better-sqlite3 binding when a prebuilt binary is packaged.

- UNITY_MCP_SKIP_NATIVE_BUILD=1 to skip native preload (forces sql.js fallback)
- UNITY_MCP_FORCE_NATIVE=1 to require the prebuilt binary (install fails if missing)

Troubleshooting

- Troubleshooting index: docs/troubleshooting/README.md
- “Capabilities: none” fix: docs/troubleshooting/capabilities-none.md`

License

MIT License - see LICENSE file for details.