Skip to content

Deployment: Dockerfile and Smithery config #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
FROM python:3.12-slim

# Set working directory
WORKDIR /app

# Copy source code
COPY UnityMcpServer/src/ .

# Install dependencies and the package
RUN pip install --no-cache-dir .

# Default command to run the MCP server
CMD ["python", "server.py"]
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Unity MCP ✨

[![smithery badge](https://smithery.ai/badge/@justinpbarnett/unity-mcp)](https://smithery.ai/server/@justinpbarnett/unity-mcp)

**Connect your Unity Editor to LLMs using the Model Context Protocol.**

Unity MCP acts as a bridge, allowing AI assistants (like Claude, Cursor) to interact directly with your Unity Editor via a local **MCP (Model Context Protocol) Client**. Give your LLM tools to manage assets, control scenes, edit scripts, and automate tasks within Unity.
Expand Down Expand Up @@ -46,6 +48,14 @@ Unity MCP connects your tools using two components:

> **Note:** The setup is constantly improving as we update the package. Check back if you randomly start to run into issues.

### Installing via Smithery

To install Unity MCP for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@justinpbarnett/unity-mcp):

```bash
npx -y @smithery/cli install @justinpbarnett/unity-mcp --client claude
```

### Prerequisites

<details>
Expand Down
13 changes: 13 additions & 0 deletions smithery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml

startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
description: No configuration required to run the Unity MCP Server.
commandFunction:
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
|-
(config) => ({command: 'python', args: ['server.py'], env: {}})
exampleConfig: {}