{"_rev":"9-b74615efd5d23a866e13091a560421a9","time":{"created":"2025-08-04T03:07:46.144Z","modified":"2025-08-04T03:07:46.661Z","1.0.1":"2025-06-22T10:06:24.013Z","1.1.0":"2025-06-22T10:09:00.481Z","1.1.1":"2025-06-22T10:13:04.172Z","1.1.2":"2025-06-22T10:15:06.800Z","1.1.3":"2025-06-22T10:18:24.084Z","1.0.0":"2025-06-22T11:15:55.069Z","1.0.2":"2025-08-04T03:07:46.397Z"},"_id":"@hrrrsn/mcp-vnc","name":"@hrrrsn/mcp-vnc","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.2":{"name":"@hrrrsn/mcp-vnc","version":"1.0.2","description":"Model Context Protocol (MCP) server enabling AI agents to control remote desktops","main":"dist/index.js","type":"module","bin":{"mcp-vnc":"dist/index.js"},"scripts":{"build":"tsc","start":"node dist/index.js","dev":"npm run build && npm start","test":"npm run build && node dist/test.js","prepublishOnly":"npm run build","prepare":"npm run build"},"keywords":["mcp","vnc","remote-control","model-context-protocol","automation","desktop-control"],"author":{"name":"Harrison Gulliver","email":"harrison.p.gulliver@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/hrrrsn/mcp-vnc.git"},"bugs":{"url":"https://github.com/hrrrsn/mcp-vnc/issues"},"homepage":"https://github.com/hrrrsn/mcp-vnc","license":"MIT","dependencies":{"@computernewb/nodejs-rfb":"^0.4.2","@modelcontextprotocol/sdk":"^1.0.0","sharp":"^0.34.0"},"devDependencies":{"@types/node":"22.16.5","typescript":"5.8.3"},"engines":{"node":">=22.0.0"},"publishConfig":{"access":"public"},"_id":"@hrrrsn/mcp-vnc@1.0.2","gitHead":"5741b5afc41c99001bb29c204e0f551bc5195bf6","_nodeVersion":"22.17.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-RgXWBprR7q6Ro8MEchqL30GGXOlZiFFhPq6z1a3Pbd55frFWhzBzmq64p10CsFsL0vaZ7RuFcpevyVdhFmiytQ==","shasum":"f5b34edac40230bbd49968e8df6c98d20c36b8d3","tarball":"https://registry.npmjs.org/@hrrrsn/mcp-vnc/-/mcp-vnc-1.0.2.tgz","fileCount":12,"unpackedSize":62844,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIBIYj0IDf5LSaZRewtcKYGQ33GjqHeLegmjjc1E3U/BuAiA3Ph7tLgVPWNuywRsEadC5/DgOsvcZ/Y7e6h13BBWvbg=="}]},"_npmUser":{"name":"hrrrsn","email":"harrison.p.gulliver@gmail.com"},"directories":{},"maintainers":[{"name":"hrrrsn","email":"harrison.p.gulliver@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp-vnc_1.0.2_1754276866211_0.6453508752868744"},"_hasShrinkwrap":false}},"maintainers":[{"name":"hrrrsn","email":"harrison.p.gulliver@gmail.com"}],"description":"Model Context Protocol (MCP) server enabling AI agents to control remote desktops","homepage":"https://github.com/hrrrsn/mcp-vnc","keywords":["mcp","vnc","remote-control","model-context-protocol","automation","desktop-control"],"repository":{"type":"git","url":"git+https://github.com/hrrrsn/mcp-vnc.git"},"author":{"name":"Harrison Gulliver","email":"harrison.p.gulliver@gmail.com"},"bugs":{"url":"https://github.com/hrrrsn/mcp-vnc/issues"},"license":"MIT","readme":"# 💻 mcp-vnc\n\n[![Node.js Version](https://img.shields.io/badge/node-%3E%3D22.0.0-brightgreen)](https://nodejs.org)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n[![npm version](https://badge.fury.io/js/@hrrrsn%2Fmcp-vnc.svg)](https://badge.fury.io/js/@hrrrsn%2Fmcp-vnc)\n\nA [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that enables AI agents to remotely control Windows, Linux, macOS or anything else that can run a VNC server (don't worry, it's probably fine).\n\n![Screenshot](.github/screenshot.png)\n\n## 🚀 Quick Start\n\n### Install from NPM\n\n```bash\nnpm install -g @hrrrsn/mcp-vnc\n```\n\n### Install from Source\n\n```bash\ngit clone https://github.com/hrrrsn/mcp-vnc\ncd mcp-vnc\nnpm install\nnpm run build\n```\n\n## ⚙️ Configuration\n\n### Claude Desktop\n\n1. Locate and open your Claude Desktop configuration file:\n   - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`\n   - **Windows**: `%APPDATA%\\Claude\\claude_desktop_config.json`\n   - **Linux**: `~/.config/Claude/claude_desktop_config.json`\n\n2. Add the following configuration:\n\n**Using NPM Install:**\n```json\n{\n  \"mcpServers\": {\n    \"vnc-controller\": {\n      \"type\": \"stdio\",\n      \"command\": \"mcp-vnc\",\n      \"env\": {\n        \"VNC_HOST\": \"192.168.1.100\",\n        \"VNC_PORT\": \"5900\",\n        \"VNC_PASSWORD\": \"your-vnc-password\"\n      }\n    }\n  }\n}\n```\n\n**Built from Source:**\n```json\n{\n  \"mcpServers\": {\n    \"vnc-controller\": {\n      \"type\": \"stdio\",\n      \"command\": \"node\",\n      \"args\": [\"dist/index.js\"],\n      \"cwd\": \"/path/to/mcp-vnc\",\n      \"env\": {\n        \"VNC_HOST\": \"192.168.1.100\",\n        \"VNC_PORT\": \"5900\",\n        \"VNC_PASSWORD\": \"your-vnc-password\"\n      }\n    }\n  }\n}\n```\n\n### VS Code\n\nPlease refer to the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)\n\n## 🛠️ Available Tools\n\nThe MCP server provides the following tools for remote desktop control:\n\n### 🖱️ Mouse Control\n\n<details>\n<summary><strong>vnc_click</strong> - Click at specified coordinates</summary>\n\n| Parameter | Required | Type | Description | Default |\n|-----------|----------|------|-------------|---------|\n| `x` | ✅ | number | X coordinate | - |\n| `y` | ✅ | number | Y coordinate | - |\n| `button` | ❌ | string | Mouse button (`left`, `right`, `middle`) | `left` |\n| `double` | ❌ | boolean | Double-click instead of single click | `false` |\n\n**Example:** `vnc_click(x=100, y=200, button=\"right\", double=true)`\n</details>\n\n<details>\n<summary><strong>vnc_move_mouse</strong> - Move mouse cursor</summary>\n\n| Parameter | Required | Type | Description |\n|-----------|----------|------|-------------|\n| `x` | ✅ | number | X coordinate |\n| `y` | ✅ | number | Y coordinate |\n\n**Example:** `vnc_move_mouse(x=500, y=300)`\n</details>\n\n### ⌨️ Keyboard Control\n\n<details>\n<summary><strong>vnc_key_press</strong> - Send keys and key combinations</summary>\n\n| Parameter | Required | Type | Description |\n|-----------|----------|------|-------------|\n| `key` | ✅ | string | Key or key combination to press |\n\n**Supported Keys:**\n- **Single keys**: `a`, `Enter`, `F1`, `Escape`, `Up`, `Down`, `Tab`, `Space`\n- **Key combinations**: `Ctrl+c`, `Alt+F4`, `Ctrl+Alt+Delete`, `Shift+Tab`\n- **Modifiers**: `Ctrl`, `Alt`, `Shift`, `Super`/`Win`, `Meta`/`Cmd`\n\n**Examples:** \n- `vnc_key_press(key=\"Enter\")`\n- `vnc_key_press(key=\"Ctrl+Alt+Delete\")`\n</details>\n\n### 📝 Text Input\n\n<details>\n<summary><strong>vnc_type_text</strong> - Type single-line text</summary>\n\n| Parameter | Required | Type | Description | Default |\n|-----------|----------|------|-------------|---------|\n| `text` | ✅ | string | Text to type | - |\n| `enter` | ❌ | boolean | Press Enter after typing | `false` |\n\n**Example:** `vnc_type_text(text=\"Hello World!\", enter=true)`\n</details>\n\n<details>\n<summary><strong>vnc_type_multiline</strong> - Type multiple lines</summary>\n\n| Parameter | Required | Type | Description |\n|-----------|----------|------|-------------|\n| `lines` | ✅ | string[] | Array of lines to type |\n\n**Example:** `vnc_type_multiline(lines=[\"Line 1\", \"Line 2\", \"Line 3\"])`\n</details>\n\n### 📸 Screen Capture\n\n<details>\n<summary><strong>vnc_screenshot</strong> - Capture screen</summary>\n\n| Parameter | Required | Type | Description | Default |\n|-----------|----------|------|-------------|---------|\n| `delay` | ❌ | number | Delay before screenshot (0-300000ms) | `0` |\n\n**Example:** `vnc_screenshot(delay=1000)` - Wait 1 second before capture\n</details>\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.","readmeFilename":"README.md"}