Update the manual commands (#638)

update readme to use the uvx command
main
Shutong Wu 2026-01-26 23:32:20 -05:00 committed by GitHub
parent 4991d71eab
commit feb9e3b6b5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 19 additions and 19 deletions

View File

@ -30,7 +30,7 @@ The window has four areas: Server Status, Unity Bridge, MCP Client Configuration
- Actions: - Actions:
- Auto-Setup: Registers/updates your selected MCP client(s), ensures bridge connectivity. Shows “Connected ✓” after success. - Auto-Setup: Registers/updates your selected MCP client(s), ensures bridge connectivity. Shows “Connected ✓” after success.
- Rebuild MCP Server: Rebuilds the Python based MCP server - Rebuild MCP Server: Rebuilds the Python based MCP server
- Select server folder…: Choose the folder containing `server.py`. - Select server folder…: Choose the local `Server` folder (dev only; usually not needed when using uvx).
- Verify again: Re-checks server presence. - Verify again: Re-checks server presence.
- If Python isnt detected, use “Open Install Instructions”. - If Python isnt detected, use “Open Install Instructions”.
- HTTP Server Command foldout: - HTTP Server Command foldout:
@ -89,4 +89,4 @@ Notes:
- Use Cmd+Shift+M (macOS) / Ctrl+Shift+M (Windows, Linux) to toggle the MCP for Unity window. - Use Cmd+Shift+M (macOS) / Ctrl+Shift+M (Windows, Linux) to toggle the MCP for Unity window.
- Enable “Show Debug Logs” in the header for more details in the Console when diagnosing issues. - Enable “Show Debug Logs” in the header for more details in the Console when diagnosing issues.
--- ---

View File

@ -113,15 +113,15 @@ If auto-setup doesn't work, add this to your MCP client's config file:
``` ```
<details> <details>
<summary>Stdio configuration (legacy)</summary> <summary>Stdio configuration (uvx)</summary>
**macOS/Linux:** **macOS/Linux:**
```json ```json
{ {
"mcpServers": { "mcpServers": {
"unityMCP": { "unityMCP": {
"command": "uv", "command": "uvx",
"args": ["run", "--directory", "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src", "server.py", "--transport", "stdio"] "args": ["--from", "mcpforunityserver", "mcp-for-unity", "--transport", "stdio"]
} }
} }
} }
@ -132,8 +132,8 @@ If auto-setup doesn't work, add this to your MCP client's config file:
{ {
"mcpServers": { "mcpServers": {
"unityMCP": { "unityMCP": {
"command": "C:/Users/YOUR_USERNAME/AppData/Local/Microsoft/WinGet/Links/uv.exe", "command": "C:/Users/YOUR_USERNAME/AppData/Local/Microsoft/WinGet/Links/uvx.exe",
"args": ["run", "--directory", "C:/Users/YOUR_USERNAME/AppData/Local/UnityMCP/UnityMcpServer/src", "server.py", "--transport", "stdio"] "args": ["--from", "mcpforunityserver", "mcp-for-unity", "--transport", "stdio"]
} }
} }
} }

View File

@ -31,12 +31,13 @@ This sets an override stored in the Editor (key: `MCPForUnity.UvPath`) so MCP fo
{ {
"mcpServers": { "mcpServers": {
"unityMCP": { "unityMCP": {
"command": "C:\\Users\\YOU\\AppData\\Local\\Microsoft\\WinGet\\Links\\uv.exe", "command": "C:\\Users\\YOU\\AppData\\Local\\Microsoft\\WinGet\\Links\\uvx.exe",
"args": [ "args": [
"--directory", "--from",
"C:\\Users\\YOU\\AppData\\Local\\Programs\\UnityMCP\\UnityMcpServer\\src", "mcpforunityserver",
"run", "mcp-for-unity",
"server.py" "--transport",
"stdio"
] ]
} }
} }
@ -46,7 +47,7 @@ This sets an override stored in the Editor (key: `MCPForUnity.UvPath`) so MCP fo
- Manually run the same command in PowerShell to confirm it launches: - Manually run the same command in PowerShell to confirm it launches:
```powershell ```powershell
"C:\Users\YOU\AppData\Local\Microsoft\WinGet\Links\uv.exe" --directory "C:\Users\YOU\AppData\Local\Programs\UnityMCP\UnityMcpServer\src" run server.py "C:\Users\YOU\AppData\Local\Microsoft\WinGet\Links\uvx.exe" --from mcpforunityserver mcp-for-unity --transport stdio
``` ```
If that runs without error, restart Cursor and it should connect. If that runs without error, restart Cursor and it should connect.
@ -82,4 +83,3 @@ References
- GUI client PATH caveats (Cursor): [Cursor community thread](https://forum.cursor.com/t/mcp-feature-client-closed-fix/54651?page=4) - GUI client PATH caveats (Cursor): [Cursor community thread](https://forum.cursor.com/t/mcp-feature-client-closed-fix/54651?page=4)
- uv tools install location (`~/.local/bin`): [Astral docs](https://docs.astral.sh/uv/concepts/tools/) - uv tools install location (`~/.local/bin`): [Astral docs](https://docs.astral.sh/uv/concepts/tools/)

View File

@ -113,15 +113,15 @@ openupm add com.coplaydev.unity-mcp
``` ```
<details> <details>
<summary>Stdio 配置(旧版</summary> <summary>Stdio 配置(uvx</summary>
**macOS/Linux** **macOS/Linux**
```json ```json
{ {
"mcpServers": { "mcpServers": {
"unityMCP": { "unityMCP": {
"command": "uv", "command": "uvx",
"args": ["run", "--directory", "/Users/YOUR_USERNAME/Library/AppSupport/UnityMCP/UnityMcpServer/src", "server.py", "--transport", "stdio"] "args": ["--from", "mcpforunityserver", "mcp-for-unity", "--transport", "stdio"]
} }
} }
} }
@ -132,8 +132,8 @@ openupm add com.coplaydev.unity-mcp
{ {
"mcpServers": { "mcpServers": {
"unityMCP": { "unityMCP": {
"command": "C:/Users/YOUR_USERNAME/AppData/Local/Microsoft/WinGet/Links/uv.exe", "command": "C:/Users/YOUR_USERNAME/AppData/Local/Microsoft/WinGet/Links/uvx.exe",
"args": ["run", "--directory", "C:/Users/YOUR_USERNAME/AppData/Local/UnityMCP/UnityMcpServer/src", "server.py", "--transport", "stdio"] "args": ["--from", "mcpforunityserver", "mcp-for-unity", "--transport", "stdio"]
} }
} }
} }