Skip to content

Commit a947c9f

Browse files
authored
Bump dep versions (#469)
* Update server instructions with new options * Upgrade to a later version of Pydantic This should have improved Python 3.14 support * Swap order of instructions so Docker comes before local building * Add fixed versions back to the README * Update README to clarify the GitHub uvx command
1 parent edd40ec commit a947c9f

File tree

3 files changed

+151
-171
lines changed

3 files changed

+151
-171
lines changed

Server/README.md

Lines changed: 35 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,20 @@ Model Context Protocol server for Unity Editor integration. Control Unity throug
1111

1212
💬 **Join our community:** [Discord Server](https://discord.gg/y4p8KfzrN4)
1313

14-
**Required:** Install the [Unity MCP Plugin](https://github.com/CoplayDev/unity-mcp?tab=readme-ov-file#-step-1-install-the-unity-package) to connect Unity Editor with this MCP server.
14+
**Required:** Install the [Unity MCP Plugin](https://github.com/CoplayDev/unity-mcp?tab=readme-ov-file#-step-1-install-the-unity-package) to connect Unity Editor with this MCP server. You also need `uvx` (requires [uv](https://docs.astral.sh/uv/)) to run the server.
1515

1616
---
1717

1818
## Installation
1919

20-
### Option 1: Using uvx (Recommended)
20+
### Option 1: PyPI
2121

22-
Run directly from GitHub without installation:
22+
Install and run directly from PyPI using `uvx`.
2323

24-
```bash
25-
# HTTP (default)
26-
uvx --from git+https://github.com/CoplayDev/unity-mcp@v8.2.3#subdirectory=Server \
27-
mcp-for-unity --transport http --http-url http://localhost:8080
24+
**Run Server (HTTP):**
2825

29-
# Stdio
30-
uvx --from git+https://github.com/CoplayDev/unity-mcp@v8.2.3#subdirectory=Server \
31-
mcp-for-unity --transport stdio
26+
```bash
27+
uvx --from mcpforunityserver mcp-for-unity --transport http --http-url http://localhost:8080
3228
```
3329

3430
**MCP Client Configuration (HTTP):**
@@ -52,55 +48,29 @@ uvx --from git+https://github.com/CoplayDev/unity-mcp@v8.2.3#subdirectory=Server
5248
"command": "uvx",
5349
"args": [
5450
"--from",
55-
"git+https://github.com/CoplayDev/unity-mcp@v8.2.3#subdirectory=Server",
51+
"mcpforunityserver",
5652
"mcp-for-unity",
5753
"--transport",
5854
"stdio"
59-
],
60-
"type": "stdio"
55+
]
6156
}
6257
}
6358
}
6459
```
6560

66-
### Option 2: Using uv (Local Installation)
61+
### Option 2: From GitHub Source
6762

68-
For local development or custom installations:
63+
Use this to run the latest released version from the repository. Change the version to `main` to run the latest unreleased changes from the repository.
6964

70-
```bash
71-
# Clone the repository
72-
git clone https://github.com/CoplayDev/unity-mcp.git
73-
cd unity-mcp/Server
74-
75-
# Run with uv (HTTP)
76-
uv run server.py --transport http --http-url http://localhost:8080
77-
78-
# Run with uv (stdio)
79-
uv run server.py --transport stdio
80-
```
81-
82-
**MCP Client Configuration (HTTP):**
8365
```json
8466
{
8567
"mcpServers": {
8668
"UnityMCP": {
87-
"url": "http://localhost:8080/mcp"
88-
}
89-
}
90-
}
91-
```
92-
93-
**MCP Client Configuration (stdio – Windows):**
94-
```json
95-
{
96-
"mcpServers": {
97-
"UnityMCP": {
98-
"command": "uv",
69+
"command": "uvx",
9970
"args": [
100-
"run",
101-
"--directory",
102-
"C:\\path\\to\\unity-mcp\\Server",
103-
"server.py",
71+
"--from",
72+
"git+https://github.com/CoplayDev/unity-mcp@v8.2.3#subdirectory=Server",
73+
"mcp-for-unity",
10474
"--transport",
10575
"stdio"
10676
]
@@ -109,33 +79,35 @@ uv run server.py --transport stdio
10979
}
11080
```
11181

112-
**MCP Client Configuration (stdio – macOS/Linux):**
113-
```json
114-
{
115-
"mcpServers": {
116-
"UnityMCP": {
117-
"command": "uv",
118-
"args": [
119-
"run",
120-
"--directory",
121-
"/path/to/unity-mcp/Server",
122-
"server.py",
123-
"--transport",
124-
"stdio"
125-
]
126-
}
127-
}
128-
}
82+
### Option 3: Docker
83+
84+
**Use Pre-built Image:**
85+
86+
```bash
87+
docker run -p 8080:8080 msanatan/mcp-for-unity-server:latest --transport http --http-url http://0.0.0.0:8080
12988
```
13089

131-
### Option 3: Using Docker
90+
**Build Locally:**
13291

13392
```bash
13493
docker build -t unity-mcp-server .
13594
docker run -p 8080:8080 unity-mcp-server --transport http --http-url http://0.0.0.0:8080
13695
```
13796

138-
Configure your MCP client with `"url": "http://localhost:8080/mcp"`. For stdio-in-docker (rare), run the container with `--transport stdio` and use the same `command`/`args` pattern as the uv examples, wrapping it in `docker run -i ...` if needed.
97+
Configure your MCP client with `"url": "http://localhost:8080/mcp"`.
98+
99+
### Option 4: Local Development
100+
101+
For contributing or modifying the server code:
102+
103+
```bash
104+
# Clone the repository
105+
git clone https://github.com/CoplayDev/unity-mcp.git
106+
cd unity-mcp/Server
107+
108+
# Run with uv
109+
uv run src/main.py --transport stdio
110+
```
139111

140112
---
141113

Server/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ dependencies = [
3232
"httpx>=0.27.2",
3333
"fastmcp>=2.13.0,<2.13.2",
3434
"mcp>=1.16.0",
35-
"pydantic>=2.12.0",
35+
"pydantic>=2.12.5",
3636
"tomli>=2.3.0",
3737
"fastapi>=0.104.0",
3838
"uvicorn>=0.35.0",

0 commit comments

Comments
 (0)