Skip to content

Commit 9be1c52

Browse files
Merge pull request #198 from Cheffromspace/docs/quickstart-improvements
docs: improve quickstart with comprehensive build tools setup
2 parents ca0b992 + e687754 commit 9be1c52

File tree

1 file changed

+51
-18
lines changed

1 file changed

+51
-18
lines changed

README.md

Lines changed: 51 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,29 +26,62 @@ MCPControl bridges the gap between AI models and your desktop, enabling secure,
2626

2727
## 🔌 Quick Start
2828

29-
1. **Install Node.js** (if not already installed)
29+
### Prerequisites
30+
31+
1. **Install Build Tools (including VC++ workload)**
32+
```powershell
33+
# Run as Administrator - may take a few minutes to complete
34+
winget install Microsoft.VisualStudio.2022.BuildTools --override "--wait --passive --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended"
35+
```
36+
37+
2. **Install Python** (if not already installed)
38+
```powershell
39+
# Install Python (required for node-gyp)
40+
winget install Python.Python.3.12
3041
```
31-
# Visit https://nodejs.org and download the latest LTS version
42+
43+
3. **Install Node.js**
44+
```powershell
45+
# Install latest LTS version
46+
winget install OpenJS.NodeJS
3247
```
3348

34-
2. **Configure MCP settings** in your Claude client:
35-
36-
```json
37-
{
38-
"mcpServers": {
39-
"MCPControl": {
40-
"command": "npx",
41-
"args": [
42-
"--no-cache",
43-
"-y",
44-
"mcp-control"
45-
]
46-
}
47-
}
48-
}
49+
### Installation
50+
51+
1. **Install MCPControl Package**
52+
```powershell
53+
npm install -g mcp-control
4954
```
5055

51-
3. **Restart your client** and MCPControl will appear in your MCP menu!
56+
### Configuration
57+
58+
MCPControl works best in a **virtual machine at 1280x720 resolution** for optimal click accuracy.
59+
60+
Configure your Claude client to use the SSE transport:
61+
62+
```json
63+
{
64+
"mcpServers": {
65+
"MCPControl": {
66+
"command": "mcp-control",
67+
"args": [
68+
"--transport",
69+
"sse"
70+
]
71+
}
72+
}
73+
}
74+
```
75+
76+
### Launch Server Manually (Optional)
77+
78+
You can also run the server directly with SSE:
79+
80+
```bash
81+
mcp-control --transport sse
82+
```
83+
84+
**Restart your client** and MCPControl will appear in your MCP menu!
5285

5386
## 🔧 CLI Options
5487

0 commit comments

Comments
 (0)