Unity MCP

🚀 Unity MCP Server

This is an MCP server used to connect Claude to Unity projects. It is built with the Model Context Protocol SDK.

🚀 Quick Start

This MCP server enables the connection between Claude and Unity projects, facilitating seamless interaction.

✨ Features

• List all Unity projects.
• Retrieve detailed project information.
• Access project structure and files.

📦 Installation

Option 1: Use NPX (Recommended)

You can directly run this tool using npx without installation:

npx unity-mcp@latest

Configure this tool as the MCP server in Claude: On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json%

{
  "mcpServers": {
    "unity": {
      "command": "npx",
      "args": ["unity-mcp@latest"]
    }
  }
}

Option 2: Run the Project Locally

Clone this repository to run it locally:

git clone https://github.com/your-username/unity-mcp.git
cd unity-mcp
bun install

Then configure Claude to use your local version:

{
  "mcpServers": {
    "unity": {
      "command": "bun",
      "args": ["run", "C:\\Users\\Artga\\Code\\unity-mcp\\src\\index.ts"]
    }
  }
}

Requirements

• Unity is installed and some projects are configured.
• The Bun runtime environment is required.

Troubleshooting

If you can't get this MCP to work, please open an issue. Here are some tips:

1. Ensure that Unity is installed and some projects are configured.
2. Check if the unity-mcp server can access the projects-v1.json file.
3. Make sure you have appropriate permissions for the Unity project directory. This MCP outputs logs to standard error, which complies with the MCP specification. On MacOS, the Claude Desktop app will output these logs to ~/Library/Logs/Claude. On other platforms, you can find the logs here.

💻 Usage Examples

Basic Usage

You can quickly start using the server by following the installation steps above.

Advanced Usage

If you want to develop and debug this project, you can follow these steps:

🔧 Technical Details

Setup

# Install dependencies
bun install

# Run the project
bun run src/index.ts

# Type checking
bun run typecheck

# Format the code
bun run format

Debugging

Since the MCP server runs through standard input and output, debugging can be challenging. For the best debugging experience, we highly recommend using MCP Inspector. You can start the MCP inspector using the following command:

bun run inspector

After starting, the inspector will display a URL that you can access in your browser to start debugging.

📄 License

This project is under the MIT License. For more details, please refer to the LICENSE file.