Windows MCP Server

https://windowsmcpserver.dev/
Admin
Windows MCP Server enables AI assistants to control Windows applications through semantic UI...
Tokens:8,892
Snippets:93
Trust Score:2.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Clone and Setup Repository

Source: https://windowsmcpserver.dev/contributing

Commands to clone the repository and navigate to the project directory.

```bash
git clone https://github.com/sbroenne/mcp-windows.git
cd mcp-windows
```

--------------------------------

### Unit Test Example

Source: https://windowsmcpserver.dev/contributing

A sample unit test using the xUnit framework.

```csharp
[Fact]
public void Click_WithValidCoordinates_SendsClickInput()
{
    // Arrange
    var service = new MouseInputService();
    
    // Act
    var result = service.Click(100, 200);
    
    // Assert
    Assert.True(result.Success);
}
```

--------------------------------

### Commit Message Examples

Source: https://windowsmcpserver.dev/contributing

Examples of valid conventional commit messages.

```text
feat(keyboard): add macro recording support

Implement ability to record and replay keyboard sequences.
Fixes #123
```

```text
fix(window): resolve activation timeout on slow systems

Increase default timeout and add exponential backoff retry logic.
```

--------------------------------

### Building a VS Code Extension

Source: https://windowsmcpserver.dev/contributing

Commands to install dependencies, compile TypeScript, package the extension into a VSIX file, and run it in development mode.

```bash
cd vscode-extension

# Install dependencies
npm install

# Build TypeScript
npm run compile

# Package VSIX
npm run package

# Run in development mode
npm run watch

```

--------------------------------

### Launch Notepad and Type Text

Source: https://windowsmcpserver.dev/features

Launches Notepad using the `app` tool and then types 'Hello World' into it using `ui_type`. Requires the window handle returned by `app` for subsequent `ui_type` operation.

```python
app(programPath='notepad.exe') → handle='123456'
ui_type(windowHandle='123456', text='Hello World')
```

--------------------------------

### Build and Restore Dependencies

Source: https://windowsmcpserver.dev/contributing

Standard .NET CLI commands to restore dependencies and build the project.

```bash
dotnet restore
```

```bash
dotnet build
```

--------------------------------

### Run Project Tests

Source: https://windowsmcpserver.dev/contributing

Command to execute the project's test suite.

```bash
dotnet test
```

--------------------------------

### List All Monitors

Source: https://windowsmcpserver.dev/features

List all connected monitors available on the system. This action requires no parameters.

```python
screenshot_capture.list_monitors()
```

--------------------------------

### App Tool - Launch Applications

Source: https://windowsmcpserver.dev/features

Launches applications and retrieves their window handles for subsequent operations.

```APIDOC
## App (`app`)

### Description
Launch applications and get their window handles for subsequent operations.

### Method
`app`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters Table
Parameter | Description | Required  
---|---|---  
`programPath` | Program to launch (e.g., ‘notepad.exe’, ‘C:\Program Files\…\app.exe’) | Yes  
`arguments` | Command-line arguments | No  
`workingDirectory` | Working directory for the process | No  
`waitForWindow` | Wait for window to appear (default: true) | No  

### Capabilities
  * Launch applications by name or full path
  * Automatic window detection after launch
  * Returns window handle for use with other tools
  * Configurable startup parameters

### Request Example
```python
app(programPath='notepad.exe')
```

### Response
#### Success Response (200)
- **handle** (string) - The handle of the launched application window.

#### Response Example
```json
{
  "handle": "123456"
}
```

### Usage Example
```python
app_handle = app(programPath='notepad.exe')
ui_type(windowHandle=app_handle, text='Hello World')
```
```

--------------------------------

### Configuration - Environment Variables

Source: https://windowsmcpserver.dev/features

This section details the configurable environment variables for the MCPServer.

```APIDOC
## Configuration - Environment Variables

### Description
These environment variables allow customization of the MCPServer's behavior, particularly for keyboard, mouse, and window operations.

### Environment Variables Table
Variable | Default | Description  
---|---|---
`MCP_WINDOWS_KEYBOARD_CHUNK_DELAY_MS` | `10` | Delay between text chunks  
`MCP_WINDOWS_KEYBOARD_KEY_DELAY_MS` | `10` | Delay between key presses  
`MCP_WINDOWS_KEYBOARD_SEQUENCE_DELAY_MS` | `50` | Delay between sequence keys  
`MCP_WINDOWS_MOUSE_MOVE_DELAY_MS` | `10` | Delay after mouse move  
`MCP_WINDOWS_MOUSE_CLICK_DELAY_MS` | `50` | Delay after mouse click  
`MCP_WINDOWS_WINDOW_TIMEOUT_MS` | `5000` | Default window operation timeout  
`MCP_WINDOWS_WINDOW_WAITFOR_TIMEOUT_MS` | `30000` | Default wait_for timeout  
`MCP_WINDOWS_WINDOW_PROPERTY_TIMEOUT_MS` | `100` | Timeout for querying window properties  
`MCP_WINDOWS_WINDOW_POLLING_INTERVAL_MS` | `250` | Polling interval for wait_for  
`MCP_WINDOWS_WINDOW_ACTIVATION_MAX_RETRIES` | `3` | Max retries for window activation  
`MCP_WINDOWS_SCREENSHOT_TIMEOUT_MS` | `5000` | Screenshot operation timeout  
`MCP_WINDOWS_SCREENSHOT_MAX_PIXELS` | `33177600` | Maximum capture size (default 8K)
```

--------------------------------

### Plain Screenshot Request

Source: https://windowsmcpserver.dev/features

Use for simple screenshots without element discovery. Ensure the 'windowHandle' is correctly specified for the target window.

```json
{
  "action": "capture",
  "windowHandle": "123456",
  "annotate": false
}

```

--------------------------------

### Capture All Monitors

Source: https://windowsmcpserver.dev/features

Capture a composite screenshot of all connected displays. This action requires no parameters.

```python
screenshot_capture.capture(target='all_monitors')
```

--------------------------------

### Browser Automation - General Concepts

Source: https://windowsmcpserver.dev/features

General strategies and concepts for automating browser interactions, including auto-detection of Chromium browsers, launching applications, and interacting with UI elements.

```APIDOC
## Browser Automation Concepts

### Auto-Detection
Chromium-based browsers like Edge and Chrome are auto-detected and can be interacted with using a deep Chromium strategy.

### Launching Applications
Launch applications using the `app` tool. For example, to launch Microsoft Edge with a specific URL:
```
app(programPath='msedge.exe', arguments='https://example.com')
```

### UI Element Interaction
UI elements (links, buttons, form fields) are typically identified by their visible text or ARIA labels. Use `ui_find`, `ui_click`, and `ui_type` for interaction.

### Authenticated Sites
For sites requiring authentication or SSO, it's recommended to reuse an existing signed-in browser window. A launcher helper exiting immediately might indicate an existing session.

### Screenshots
Use `screenshot_control` to get annotated element metadata without image bytes by default. Opt-in for image bytes if needed.

### Browser Chrome Shortcuts
For browser UI elements (address bar, tabs), use keyboard shortcuts like `Ctrl+L`, `Ctrl+R`, and `Ctrl+Tab`.

### Best-Effort Coverage
Browser chrome and non-Chromium browsers are treated as best-effort until dedicated coverage expands.

### Deterministic Smoke Tests
The Chromium smoke slice runs by default, including local Edge/Chrome test pages and a public web smoke check against `https://demo.playwright.dev/todomvc/`.

### Chromium Browser Model
Chromium browser coverage follows a semantic-first model, similar to Electron, with deep Chromium tree search, ARIA/visible-text discovery, and no separate browser-only tool family.

### Deterministic Smoke Harness
The smoke harness launches Edge and Chrome with isolated browser state (`--user-data-dir`), forces renderer accessibility, waits for page readiness signals, and uses popup dismissal as a fallback.
```

--------------------------------

### Window Management API

Source: https://windowsmcpserver.dev/features

Endpoints for controlling and managing windows on the Windows desktop.

```APIDOC
## POST /window_management

### Description
Perform various window management actions such as listing, finding, activating, resizing, and closing windows.

### Method
POST

### Endpoint
/window_management

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform (e.g., list, find, activate, minimize, maximize, restore, close, move, resize, set_bounds, wait_for, wait_for_state, move_to_monitor, move_and_activate, ensure_visible)
- **handle** (string) - Optional - The window handle for the target window
- **title** (string) - Optional - Window title for find or wait_for actions
- **processName** (string) - Optional - Process name for find action
- **discardChanges** (boolean) - Optional - Whether to discard changes when closing
- **x, y, width, height** (integer) - Optional - Coordinates and dimensions for move/resize actions
- **state** (string) - Optional - Target window state for wait_for_state
- **timeoutMs** (integer) - Optional - Timeout in milliseconds for wait_for_state
- **target, monitorIndex** (string/integer) - Optional - Monitor identifiers for move_to_monitor actions

### Request Example
{
  "action": "close",
  "handle": "123456",
  "discardChanges": true
}
```

--------------------------------

### Configure Windows MCP Server

Source: https://windowsmcpserver.dev/

Add this configuration to your MCP client settings to register the Windows MCP server executable.

```json
{ "servers": { "windows": { "command": "path/to/Sbroenne.WindowsMcp.exe" } } }
```

--------------------------------

### Capture Screenshot to File

Source: https://windowsmcpserver.dev/features

Capture a screenshot and save it to a specified file path. Use `outputMode='file'` and provide the `outputPath`.

```python
screenshot_capture.capture(outputMode='file', outputPath='C:\\Users\\User\\Desktop\\screenshot.png')
```

--------------------------------

### Capture Screenshot of Application

Source: https://windowsmcpserver.dev/features

Capture a screenshot of a specific application window. By default, screenshots include annotated element overlays. Use `app` for the application name (partial title match).

```python
screenshot_capture.capture(app='notepad.exe')
```

--------------------------------

### VS Code Extension File Structure

Source: https://windowsmcpserver.dev/contributing

This is the typical directory structure for a VS Code extension project. The main entry point is 'extension.ts', with 'package.json' defining the extension's manifest.

```plaintext
vscode-extension/
├── src/
│   └── extension.ts          # Main extension entry point
├── package.json              # Extension manifest
├── tsconfig.json             # TypeScript configuration
└── bin/                       # Compiled MCP server binaries

```

--------------------------------

### Run LLM Integration Tests

Source: https://windowsmcpserver.dev/contributing

Commands to execute LLM-based integration tests using pytest.

```bash
# Run all LLM tests
cd tests/Sbroenne.WindowsMcp.LLM.Tests
uv run pytest -v

# Run specific test
uv run pytest test_notepad_ui.py -v

# Run integration tests
uv run pytest integration/ -v
```

--------------------------------

### Execute Test Categories and Coverage

Source: https://windowsmcpserver.dev/contributing

Commands for running specific test categories or generating code coverage reports.

```bash
# All tests
dotnet test

# Specific category
dotnet test --filter "Category=Unit"
dotnet test --filter "Category=Integration"

# Specific test class
dotnet test --filter "FullyQualifiedName~MouseInputServiceTests"

# With code coverage
dotnet test /p:CollectCoverage=true /p:CoverageFormat=opencover
```

--------------------------------

### File Save (file_save)

Source: https://windowsmcpserver.dev/features

Handles the file save workflow via Save As dialogs for English Windows.

```APIDOC
## File Save (file_save)

### Description
Save files via Save As dialog. Handles the entire save workflow: triggers save, waits for dialog, fills path, confirms. English Windows only.

### Parameters
#### Request Body
- **windowHandle** (string) - Required - Target window handle (the app window, not a dialog)
- **filePath** (string) - Optional - File path to save to (e.g., ‘C:\\Users\\User\\file.txt’)
```

--------------------------------

### Mouse Control

Source: https://windowsmcpserver.dev/features

Provides mouse input control with multi-monitor and DPI awareness.

```APIDOC
## Mouse Control

### Description
Control mouse input on Windows with full multi-monitor and DPI awareness.

### Actions
- **move**: Move cursor to coordinates (x, y, target or monitorIndex)
- **click**: Left-click at coordinates (optional: x, y)
- **double_click**: Double-click at coordinates (optional: x, y)
- **right_click**: Right-click at coordinates (optional: x, y)
- **middle_click**: Middle-click at coordinates (optional: x, y)
- **drag**: Drag from current position to coordinates (x, y, endX, endY)
- **scroll**: Scroll at coordinates (direction, optional: x, y, amount)
- **get_position**: Get current cursor position with monitor context
```

--------------------------------

### Launch Edge Browser with a URL

Source: https://windowsmcpserver.dev/features

Launches the Microsoft Edge browser and navigates to a specific URL. This is part of the browser automation strategy for Chromium-based applications.

```python
app(programPath='msedge.exe', arguments='https://example.com')
```

--------------------------------

### Capture Primary Screen

Source: https://windowsmcpserver.dev/features

Capture a screenshot of the primary display monitor. This is the default behavior if no target is specified.

```python
screenshot_capture.capture(target='primary_screen')
```

--------------------------------

### Capture Specific Window by Handle

Source: https://windowsmcpserver.dev/features

Capture a screenshot of a specific window identified by its handle. Use the `windowHandle` parameter for this purpose.

```python
screenshot_capture.capture(windowHandle='0x123456')
```

--------------------------------

### Capture Screenshot with Custom Quality and Format

Source: https://windowsmcpserver.dev/features

Capture a screenshot with custom JPEG compression quality and specify the output format. The default quality is 60 and the default format is 'jpeg'.

```python
screenshot_capture.capture(quality=90, imageFormat='png')
```

--------------------------------

### UI Find Tool - Find UI Elements

Source: https://windowsmcpserver.dev/features

Finds and discovers UI elements within a specified window based on various criteria.

```APIDOC
## UI Find (`ui_find`)

### Description
Find and discover UI elements by name, type, or automation ID.

### Method
`ui_find`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters Table
Parameter | Description | Required  
---|---|---  
`windowHandle` | Target window handle | Yes  
`name` | Exact element name | No  
`nameContains` | Partial name match | No  
`namePattern` | Regex pattern for name | No  
`automationId` | Automation ID (most reliable) | No  
`controlType` | Control type (Button, Edit, CheckBox, etc.) | No  
`maxResults` | Maximum elements to return | No  
`sortByProminence` | Sort by bounding box area | No  

### Capabilities
  * Find elements by name, control type, or automation ID
  * Partial name matching with `nameContains`
  * Regex pattern matching with `namePattern`
  * Sort results by prominence (largest first) for disambiguation
  * Returns element IDs for use with other ui_* tools
  * Electron app support (VS Code, Teams, Slack)

### Request Example
```python
ui_find(windowHandle='123456', name='Submit')
```

### Response
#### Success Response (200)
- **elements** (array) - A list of found UI elements, each with an `elementId` and other properties.

#### Response Example
```json
{
  "elements": [
    {
      "elementId": "abc789",
      "name": "Submit",
      "controlType": "Button"
    }
  ]
}
```
```

--------------------------------

### XML Documentation Comments for C# API

Source: https://windowsmcpserver.dev/contributing

Use XML documentation comments for public APIs to describe their purpose, parameters, and return values. This aids in generating documentation and provides intellisense.

```csharp
/// <summary>
/// Sends a mouse click at the specified coordinates.
/// </summary>
/// <param name="x">X coordinate in screen space</param>
/// <param name="y">Y coordinate in screen space</param>
/// <returns>Result indicating success or failure</returns>
public ClickResult Click(int x, int y)
{
    // Implementation
}
```

--------------------------------

### JSON Response Optimization Comparison

Source: https://windowsmcpserver.dev/features

Compares standard JSON responses with optimized versions, highlighting significant token savings for LLM efficiency. Optimized JSON omits null values and uses short property names.

```json
// Standard JSON (~180 tokens)
{
  "success": true,
  "errorCode": "success",
  "message": "Clicked element",
  "element": {
    "name": "Save",
    "controlType": "Button",
    "handle": "123"
  }
}
```

```json
// Optimized JSON (~60 tokens)
{
  "ok": true,
  "ec": "success",
  "msg": "Clicked",
  "el": {
    "n": "Save",
    "t": "Button",
    "h": "123"
  }
}
```

--------------------------------

### Define Branch Naming Pattern

Source: https://windowsmcpserver.dev/contributing

The required format for naming feature branches.

```text
<type>/<short-description>
```

--------------------------------

### Keyboard Control

Source: https://windowsmcpserver.dev/features

Provides keyboard input control with Unicode support and various key actions.

```APIDOC
## Keyboard Control

### Description
Control keyboard input on Windows with Unicode support.

### Actions
- **type**: Type text using Unicode input (text)
- **press**: Press and release a key (key, optional modifiers)
- **key_down**: Hold a key down (key)
- **key_up**: Release a held key (key)
- **sequence**: Multiple keys in order (keys)
- **release_all**: Release all held keys
- **get_keyboard_layout**: Query current layout
- **wait_for_idle**: Wait for keyboard input to be processed
```

--------------------------------

### Screenshot Capture API

Source: https://windowsmcpserver.dev/features

Endpoints for capturing screenshots of the desktop or specific application windows.

```APIDOC
## POST /screenshot_capture

### Description
Capture screenshots of the desktop or specific windows, with optional element annotations.

### Method
POST

### Endpoint
/screenshot_capture

### Parameters
#### Request Body
- **target** (string) - Required - Capture target (app, primary_screen, secondary_screen, monitor, window, region, all_monitors)
- **app** (string) - Optional - Application name for target 'app'
- **annotate** (boolean) - Optional - Include numbered element overlays (default: true)
- **includeCursor** (boolean) - Optional - Include mouse cursor (default: false)
- **imageFormat** (string) - Optional - Output format: "jpeg", "png" (default: "jpeg")
- **quality** (integer) - Optional - JPEG compression quality 1-100 (default: 60)
- **outputMode** (string) - Optional - "inline" or "file" (default: "inline")
- **outputPath** (string) - Optional - Custom file path for file output mode

### Request Example
{
  "target": "app",
  "app": "notepad",
  "annotate": true,
  "imageFormat": "png"
}
```

--------------------------------

### Annotated Screenshot Response

Source: https://windowsmcpserver.dev/features

Use when you don't know element names. The numbered labels in the image correspond to the structured element data, making it easy to identify what to click.

```json
{
  "success": true,
  "annotated_elements": [
    { "index": 1, "element_id": "...", "name": "File", "control_type": "MenuItem", "clickable_point": { "x": 50, "y": 30 } },
    { "index": 2, "element_id": "...", "name": "Edit", "control_type": "MenuItem", "clickable_point": { "x": 100, "y": 30 } }
  ],
  "element_count": 25
}

```

--------------------------------

### Conventional Commit Format

Source: https://windowsmcpserver.dev/contributing

The standard structure for commit messages in the repository.

```text
<type>(<scope>): <subject>

<body>

<footer>
```

--------------------------------

### UI Read (ui_read)

Source: https://windowsmcpserver.dev/features

Reads text from UI elements using UI Automation or OCR fallback.

```APIDOC
## UI Read (ui_read)

### Description
Read text from elements using UI Automation or OCR.

### Parameters
#### Query Parameters
- **windowHandle** (string) - Required - Target window handle
- **name** (string) - Optional - Element name
- **nameContains** (string) - Optional - Element name partial match
- **automationId** (string) - Optional - Automation ID
- **controlType** (string) - Optional - Control type filter
- **includeChildren** (boolean) - Optional - Include child element text (default: false)
- **language** (string) - Optional - OCR language code (e.g., ‘en-US’)
```

--------------------------------

### Error Handling

Source: https://windowsmcpserver.dev/features

This section lists common error codes and their descriptions for the API.

```APIDOC
## Error Codes

### Description
The server handles common Windows security scenarios and operational errors.

### Error Codes Table
Error Code | Description  
---|---
`ElevatedWindowActive` | Target window is running as Administrator  
`SecureDesktopActive` | UAC prompt or lock screen is active  
`InvalidKey` | Unrecognized key name  
`InputBlocked` | Input was blocked by UIPI  
`Timeout` | Operation timed out  
`OperationTimeout` | Operation timed out (with configured timeout duration)  
`InvalidMonitorIndex` | Monitor index out of range  
`InvalidWindowHandle` | Window handle is invalid or window no longer exists  
`MissingRequiredParameter` | A required parameter was not provided  
`CoordinatesOutOfBounds` | Coordinates are outside monitor boundaries  
`WindowMinimized` | Cannot capture minimized window  
`WindowNotVisible` | Window is not visible  
`InvalidRegion` | Capture region has invalid dimensions  
`CaptureFailed` | Screenshot capture operation failed  
`SizeLimitExceeded` | Requested capture exceeds maximum allowed size  
`WrongTargetWindow` | Foreground window doesn’t match expected title/process (use expectedWindowTitle/expectedProcessName)
```

--------------------------------

### Capture Specific Monitor

Source: https://windowsmcpserver.dev/features

Capture a screenshot of a specific monitor by its index. The `monitorIndex` parameter specifies which monitor to capture.

```python
screenshot_capture.capture(monitor=2)
```

--------------------------------

### Screenshot API Endpoints

Source: https://windowsmcpserver.dev/features

This section details the API endpoints for capturing screenshots, both annotated and plain.

```APIDOC
## POST /api/screenshot

### Description
Captures a screenshot of the specified window or monitor with optional annotations.

### Method
POST

### Endpoint
/api/screenshot

### Parameters
#### Query Parameters
- **annotate** (boolean) - Optional - If true, includes structured element data in the response. Defaults to true.
- **includeImage** (boolean) - Optional - If true, includes the image data in the response. Defaults to false.
- **windowHandle** (string) - Optional - The handle of the window to capture. If not provided, captures the entire screen.
- **monitorIndex** (integer) - Optional - The index of the monitor to capture. Used when `windowHandle` is not specified.
- **region** (object) - Optional - Defines a rectangular area to capture. Example: `{"x": 100, "y": 100, "width": 200, "height": 200}`.
- **format** (string) - Optional - The image format (e.g., 'jpeg', 'png'). Defaults to 'jpeg'.
- **quality** (integer) - Optional - The image quality (1-100). Defaults to 60.
- **maxWidth** (integer) - Optional - The maximum width for auto-scaling. Set to 0 to disable. Defaults to 1568.
- **outputMode** (string) - Optional - The output mode ('inline' or 'file'). Defaults to 'inline'.
- **includeCursor** (boolean) - Optional - If true, includes the mouse cursor in the capture. Defaults to false.

### Request Body
```json
{
  "action": "capture",
  "windowHandle": "123456",
  "annotate": false
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **annotated_elements** (array) - A list of structured data for annotated elements (if `annotate` is true).
  - **index** (integer) - The index of the element.
  - **element_id** (string) - The unique identifier for the element.
  - **name** (string) - The name of the element.
  - **control_type** (string) - The type of UI control.
  - **clickable_point** (object) - The coordinates of the clickable point.
    - **x** (integer) - The x-coordinate.
    - **y** (integer) - The y-coordinate.
- **element_count** (integer) - The total number of annotated elements.

#### Response Example (Annotated)
```json
{
  "success": true,
  "annotated_elements": [
    { "index": 1, "element_id": "...", "name": "File", "control_type": "MenuItem", "clickable_point": { "x": 50, "y": 30 } },
    { "index": 2, "element_id": "...", "name": "Edit", "control_type": "MenuItem", "clickable_point": { "x": 100, "y": 30 } }
  ],
  "element_count": 25
}
```

#### Response Example (Plain)
```json
{
  "success": true
}
```
```

--------------------------------

### Capture Screenshot of Region

Source: https://windowsmcpserver.dev/features

Capture a screenshot of a specific rectangular region on the screen. Specify the region using `regionX`, `regionY`, `regionWidth`, and `regionHeight`.

```python
screenshot_capture.capture(regionX=100, regionY=100, regionWidth=200, regionHeight=300)
```

--------------------------------

### Capture Screenshot Including Cursor

Source: https://windowsmcpserver.dev/features

Capture a screenshot that includes the mouse cursor. Set `includeCursor` to `true` to enable this feature.

```python
screenshot_capture.capture(includeCursor=true)
```

--------------------------------

### UI Click Tool - Click UI Elements

Source: https://windowsmcpserver.dev/features

Clicks on specified UI elements such as buttons, tabs, and checkboxes.

```APIDOC
## UI Click (`ui_click`)

### Description
Click buttons, tabs, checkboxes, and other interactive elements.

### Method
`ui_click`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters Table
Parameter | Description | Required  
---|---|---  
`windowHandle` | Target window handle | Yes  
`elementId` | Element ID from ui_find | No*  
`name` / `nameContains` | Element name/partial match | No*  
`automationId` | Automation ID | No*  
`controlType` | Control type filter | No  
*One of elementId, name, nameContains, or automationId required.

### Capabilities
  * Click buttons, tabs, menu items
  * Toggle checkboxes and toggle buttons
  * Handles various control patterns automatically
  * Falls back to coordinate-based click if pattern fails

### Request Example
```python
ui_click(windowHandle='123456', elementId='abc789')
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the click operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### UI Type Tool - Type Text

Source: https://windowsmcpserver.dev/features

Types text into edit controls and text fields within a specified window.

```APIDOC
## UI Type (`ui_type`)

### Description
Type text into edit controls and text fields.

### Method
`ui_type`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters Table
Parameter | Description | Required  
---|---|---  
`windowHandle` | Target window handle | Yes  
`elementId` | Element ID from ui_find | No*  
`name` / `nameContains` | Element name/partial match | No*  
`automationId` | Automation ID | No*  
`text` | The text to type | Yes  
*One of elementId, name, nameContains, or automationId required.

### Capabilities
  * Type text into input fields
  * Supports various text controls

### Request Example
```python
ui_type(windowHandle='123456', elementId='def456', text='Hello World')
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the typing operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### Close Window with Discard Changes

Source: https://windowsmcpserver.dev/features

Use `discardChanges=true` to automatically dismiss “Save?” dialogs when closing a window. This is only supported for English Windows versions.

```python
window_management(action='close', handle='123456', discardChanges=true)
```
Tokens:
Raw