Skip to content

install.md

Latest commit

 

History

History
111 lines (78 loc) · 2.74 KB

install.md

File metadata and controls

111 lines (78 loc) · 2.74 KB
Raw

Install

AI IDE assisted install

Ask your AI IDE to install this MCP server from the GitHub repository URL:

Install this MCP server from https://github.com/ProAnima/unity-version-control-mcp, configure it for my Plastic SCM / Unity Version Control source-control workspace, and run uvcs_doctor.

The server has no runtime npm dependencies, so a git checkout can run directly with Node.js.

From Git Clone

This repo has no runtime npm dependencies. After cloning it, clients can run the MCP server directly with Node.

git clone https://github.com/ProAnima/unity-version-control-mcp.git uvcs-mcp
cd uvcs-mcp
node src/cli.js init-local --client=cursor,codex,claude-code,opencode,antigravity,kiro --workspace="D:/Repositories/YourWorkspace" --mode=readonly

Convenience npm scripts are also available:

npm run setup:cursor -- --workspace="D:/Repositories/YourWorkspace"
npm run setup:codex -- --workspace="D:/Repositories/YourWorkspace"
npm run setup:all -- --workspace="D:/Repositories/YourWorkspace"

init-local writes client configs that run this checkout directly:

{
  "command": "C:/Program Files/nodejs/node.exe",
  "args": ["C:/path/to/uvcs-mcp/src/cli.js"],
  "env": {
    "UVCS_WORKSPACE": "D:/Repositories/YourWorkspace",
    "UVCS_MCP_MODE": "readonly"
  }
}

Use --dry-run or --print-config to preview config changes.

Supported --client values:

cursor,cursor-global,codex,claude-desktop,claude-code,opencode,opencode-global,antigravity,kiro,kiro-global,windsurf,all

Existing config files are backed up as .bak before writing. Use --no-backup only when you intentionally want to overwrite without a backup.

Manual setup by OS

Windows:

node src/cli.js init-local --client=all --workspace="D:\Repositories\YourWorkspace"

macOS:

node src/cli.js init-local --client=all --workspace="$HOME/Repositories/YourWorkspace"

Linux:

node src/cli.js init-local --client=all --workspace="$HOME/Repositories/YourWorkspace"

If cm is not in PATH, pass an explicit CLI path:

node src/cli.js init-local --client=cursor --workspace="$HOME/Repositories/YourWorkspace" --cm="/path/to/cm"

From npm

npx -y @proanima/uvcs-mcp init

The initializer merges an uvcs MCP server block into supported client configs and keeps existing mcpServers entries.

Manual npm config

{
  "command": "npx",
  "args": ["-y", "@proanima/uvcs-mcp"],
  "env": {
    "UVCS_WORKSPACE": "D:/Repositories/YourWorkspace",
    "UVCS_MCP_MODE": "readonly"
  }
}

Troubleshooting

node src/cli.js doctor --workspace="D:/Repositories/YourWorkspace"

On Windows, if Cyrillic paths or output look broken in a terminal, run:

chcp 65001