View Control MCP Server

🚀 View Control MCP Server

A simple view control server based on the MCP Standard.

🚀 Quick Start

This is a simple view control server based on the MCP Standard. It offers functionalities such as mouse control, keyboard input, screen capture, and view scaling.

📦 Installation

npm install view-control-mcp-server

💻 Usage Examples

Start the Server

npx view-control-mcp-server

By default, the server will run on ws://localhost:4010 and http://localhost:4011.

Options

Basic Usage

Control the Mouse with JavaScript

const { MouseController } = require('view-control-mcp-server');
const mouse = new MouseController();

// Move the mouse to the specified coordinates
mouse.moveTo(100, 200);

// Simulate a left-click
mouse.click();

Send Text Input

const { KeyboardController } = require('view-control-mcp-server');
const keyboard = new KeyboardController();

// Type "Hello, World!"
keyboard.type("Hello, World!");

Capture the Screen

const { ScreenController } = require('view-control-mcp-server');
const screen = new ScreenController();

// Capture the screen and save it as a file
async function captureScreen() {
  const buffer = await screen.capture();
  // Process the buffer data
}

✨ Features

• Mouse Control: Supports mouse movement and click operations.
• Keyboard Input: Allows sending arbitrary text and key events.
• Screen Capture: Can capture a screenshot of the current screen.
• View Scaling: Supports adjusting the scale of the displayed content.

📚 Documentation

Configuration

You can create a config.json file to configure the server's behavior:

{
  "port": 4010,
  "wsPort": 4010,
  "httpPort": 4011,
  "debugMode": true,
  "max_fps": 60,
  "auto_scale": true
}

Frequently Asked Questions

How to Handle Mouse Events?

Ensure that your client library correctly implements the MCP Standard and listens for the corresponding mouse events.

How to Improve Performance?

You can try adjusting the max_fps and auto_scale parameters to find the optimal balance.

👥 Contributors

• yourusername
• contributor1
• contributor2

📄 License

MIT