electron-mcp-server
MCP server for debugging Electron apps via Chrome DevTools Protocol. Start/attach processes, capture screenshots, read console errors & network logs, inspect DOM, evaluate JS, and automate UI — built for Cursor and other MCP clients.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/amafjarkasi/electron-mcp-server with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/amafjarkasi/electron-mcp-server'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/amafjarkasi--electron-mcp-server)HTML
<a href="/listings/amafjarkasi--electron-mcp-server"><img src="/api/listings/amafjarkasi--electron-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
git clone https://github.com/amafjarkasi/electron-mcp-server.git cd electron-mcp-server npm install npm run ensure-electron npm run build npm test
🪟 Windows binary missing?
If npm warns about `allowScripts` / Electron postinstall:
.\scripts\fix-electron.cmd
That reinstalls Electron, extracts `electron.exe` with system `tar`, then runs tests.
---
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 636 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- <div align="center">
- <img src="assets/logo.svg" alt="Electron Debug MCP Logo" width="140" height="140" />
- # Electron Debug MCP
- **Real Chrome DevTools Protocol superpowers for AI coding agents.**<br/>
- *Give Cursor, Claude & autonomous agents eyes, hands, and deep runtime inspection inside Electron desktop applications.*
- <p align="center">
- <img alt="version" src="https://img.shields.io/badge/version-1.15.2-0F766E?style=flat-square" />
- <img alt="111 tools" src="https://img.shields.io/badge/111_tools-0F766E?style=flat-square" />
- <img alt="9 resources" src="https://img.shields.io/badge/9_resources-115E59?style=flat-square" />
- <img alt="6 prompts" src="https://img.shields.io/badge/6_prompts-134E4A?style=flat-square" />
- <img alt="Node" src="https://img.shields.io/badge/node-%3E%3D20-339933?style=flat-square&logo=nodedotjs&logoColor=white" />
- <img alt="Electron" src="https://img.shields.io/badge/Electron-CDP-47848F?style=flat-square&logo=electron&logoColor=white" />
- <img alt="license" src="https://img.shields.io/badge/license-ISC-F5A623?style=flat-square" />
- </p>
- <p align="center">
- <a href="#-quick-start"><b>Quick Start</b></a> •
- <a href="#-key-superpowers"><b>Superpowers</b></a> •
- <a href="#-tool-matrix-111-tools"><b>Tool Matrix</b></a> •
- <a href="#-agent-recipes"><b>Recipes</b></a> •
- <a href="#-resources--prompts"><b>Resources & Prompts</b></a> •
- <a href="#-changelog--releases"><b>Changelog</b></a> •
- <a href="#-troubleshooting"><b>Troubleshooting</b></a>
- </p>
- ---
- </div>
- ## 🌟 Why Electron Debug MCP?
- Most AI coding agents struggle with desktop applications: they can edit source code, but they cannot **see** the resulting window, **click** buttons, **read** console errors, or **diagnose** silent main-process crashes.
- **Electron Debug MCP** bridges your agent directly into your Electron runtime via the **Chrome DevTools Protocol (CDP)** and **Node inspector**, unlocking full visual, interactive, and diagnostic autonomy.
- ```mermaid
- flowchart LR
- A["🤖 AI Agent (Cursor / Claude)"] <-->|"stdio JSON-RPC"| B["⚡ Electron Debug MCP"]
- B <-->|"CDP (WebSocket)"| C["🖼️ Renderer Windows\n(DOM · AXTree · Network · V8)"]
- B <-->|"Node Inspector / V8"| D["⚙️ Main Process\n(IPC · WebContents · Windows · Fuses)"]
- ```
- ---
- ## ✨ Key Superpowers
- <table>
- <tr>
- <td width="50%">
- ### 🛡️ Runtime Security Audit
- `electron_security_audit` evaluates running windows against official Electron security guidelines. Flags `nodeIntegration`, missing `contextIsolation`, disabled sandbox, unsafe CSP, missing `setWindowOpenHandler`, unguarded `will-navigate`, and executable binary fuses.
- </td>
- <td width="50%">
- ### 🔒 Zero-Leak Secret Automation
- Automate logins and API forms without leaking credentials. `type_text({ text: "{{secret:VAR}}" })` resolves from `process.env` and automatically redacts the secret from return values, console logs, network entries, and HAR exports with `[REDACTED]`.
- </td>
- </tr>
- <tr>
- <td width="50%">
- ### 🧩 Autonomous Composite Workflows
- High-level single-turn workflows reduce round trips:
- - **`act_and_verify`**: Action → network idle → UI assertion → automatic failure screenshot if assertion fails.
- - **`triage`**: Instant health overview with page state, console errors, network failures, and resolved top exception stack.
- - **`network_failure_report`**: Aggregates failed HTTP calls with response bodies inline plus an exported HAR artifact.
- </td>
- <td width="50%">
- ### 🔌 Deep IPC Observability
- - **`ipc_tap`**: Intercepts main-process `ipcMain.handle` and `webContents.send` calls.
- - **`ipc_invoke`**: Call any registered main-process handle channel directly with custom arguments.
- - **`ipc_schema_inference`**: Analyzes traffic patterns and automatically emits inferred TypeScript interfaces for your preload bridge.
- </td>
- </tr>
- <tr>
- <td width="50%">
- ### 🗺️ Source-Mapped Stack Traces
- `resolve_stack` decodes inline base64 and external v3 source maps. When your bundled app throws an exception, the agent gets original `.ts` and `.tsx` file names, line numbers, and original source snippets rather than minified bundle noise.
- </td>
- <td width="50%">
- ### ⚡ Frictionless Agent Ergonomics
- - **Optional `processId`**: Automatically defaults to the single active app session.
- - **Tool Annotations**: Tools declare standard MCP hints (`readOnlyHint`, `destructiveHint`) so clients can auto-approve safe queries.
- - **Artifacts Resource**: Output files are indexed as `electron://artifact/{id}`.
- </td>
- </tr>
- </table>
- ---
- ## ⚡ Quick Start
- ### 1. Configure Your MCP Client
- #### 🚀 In Cursor (`~/.cursor/mcp.json` or `.cursor/mcp.json`)
- ```json
- {
- "mcpServers": {
- "electron-debug": {
- "command": "npx",
- "args": ["-y", "electron-debug-mcp@latest"]
- }
- }
- }
- ```
- #### 💬 In Claude Desktop (`claude_desktop_config.json`)
- ```json
- {
- "mcpServers": {
- "electron-debug": {
- "command": "npx",
- "args": ["-y", "electron-debug-mcp@latest"]
- }
- }
- }
- ```
- > [!TIP]
- > **Developing locally?** Run `npm run build` and configure `"command": "node"` with `"args": ["/path/to/electron-mcp-server/build/index.js"]`.
- ---
- ## 🛠️ Tool Matrix (111 Tools)
- All tools accept an optional `processId`. When only one app is running, it automatically resolves to the active process.
- ### 🚀 Lifecycle & Connection (8)
- | Tool | Description |
- | --- | --- |
- | `start_app` | Launch Electron app with remote debugging port. Set `inspectMain: true` to enable main-process debugging. |
- | `stop_app` | Terminate launched app or detach from an attached session. |
- | `attach` | Connect to a running Electron app via DevTools port or WebSocket URL. |
- | `attach_by_pid` | Detect DevTools port from an Electron OS PID's command line and attach. |
- | `find_apps` | Enumerate all running Electron processes on the host machine. |
- | `discover_apps` | Scan local TCP ports (default 9222–9322) to discover live CDP debug endpoints. |
- | `find_installed_apps` | Scan standard OS application directories for installed packaged Electron apps. |
- | `list_apps` | Enumerate all active and managed sessions with uptime, PID, and target counts. |
- ### 👁️ See & Visual Inspection (8)
- | Tool | Description |
- | --- | --- |
- | `vision` | Recommended one-shot snapshot: viewport screenshot, page URL/title, console errors, and network failures. Supports `markElements: true` for Set-of-Marks visual badges. |
- | `snapshot` | Complete semantic accessibility tree (`Accessibility.getFullAXTree`) with stable element refs (`ref: "e1"`), roles, names, and backend IDs. Supports `markElements: true`. |
- | `screenshot` | Capture viewport PNG or JPEG base64 payload. |
- | `save_screenshot` | Capture screenshot to disk (supports CSS selector clipping); registers an artifact. |
- | `diff_screenshot` | Visual regression comparison against a baseline screenshot. |
- | `start_screencast` | Stream live viewport frames into a bounded ring buffer. |
- | `stop_screencast` | Stop screencasting and optionally save the final frame to disk. |
- | `highlight` | Visually highlight a DOM element in the viewport with border and background overlays. |
- ### 🖱️ Act & UI Automation (13)
- | Tool | Description |
- | --- | --- |
- | `act_and_verify` | **Composite:** Executes an action (`click`, `type`, `click_ax`), waits for network idle, verifies assertion, and captures failure screenshot if failed. |
- | `click` | Click the center of an element matching a CSS `selector` or accessibility `ref` (e.g. `"e1"`). |
- | `click_ax` | Robust click locating an element by its accessibility name and optional role. |
- | `type_text` | Type text into focused element, `selector`, or `ref`. Supports `{{secret:VAR}}` resolution and redaction. |
- | `type_ax` | Focus an element by accessibility name and type text with secret placeholder support. |
- | `press_key` | Dispatch keypress or keyboard shortcut (Enter, Escape, Tab, Arrows, Ctrl+A, etc.). |
- | `hover` | Move mouse pointer over a CSS `selector` or `ref` without clicking. |
- | `scroll` | Scroll page or element by delta coordinates, or scroll a `selector` or `ref` into view. |
- | `drag` | Drag-and-drop between two selectors or refs with native HTML5 `dataTransfer` payload. |
- | `select_option` | Select an option in a `<select>` dropdown by value or label. |
- | `set_file_input` | Programmatically set files on an `<input type="file">`. |
- | `handle_dialog` | Automatically accept or dismiss JavaScript alerts, confirms, and prompts. |
- | `open_deep_link` | Dispatch a custom protocol deep link (e.g. `myapp://action`) into the application. |
- ### 📄 Page State & Navigation (20)
- | Tool | Description |
- | --- | --- |
- | `fill_form` | **Composite:** Smart multi-field form solver (text, select, checkbox, radio, file) with `{{secret:VAR}}` resolution, auto-submit, and UI assertion. |
- | `responsive_theme_matrix` | **Composite:** Multi-theme (`light`, `dark`) and viewport sweep detecting text clipping & horizontal overflow scrollbars. |
- | `repro_bundle` | **Composite:** Self-contained bug repro bundle (screenshot, MHTML DOM, HAR replay, console errors, logs, health) zipped into an artifact. |
- | `page_info` | Basic page details: URL, title, dimensions, readyState, and user agent. |
- | `navigate` | Navigate the active page target to a URL with configurable load-state waiting. |
- | `reload` | Reload the active page target (supports cache busting). |
- | `wait_for` | Wait for a CSS selector, page title, URL substring, or custom JS expression. |
- | `get_dom` | Retrieve page HTML markup (supports CSS selector root and `maxLength` token protection). |
- | `query_selector` | Evaluate CSS query and inspect matching elements' attributes and text content. |
- | `evaluate` | Evaluate arbitrary JavaScript in the renderer page context. |
- | `get_console_messages` | Retrieve buffered console messages and exceptions (supports level and tail filtering). |
- | `get_logs` | Retrieve captured process stdout and stderr logs. |
- | `get_cookies` | Inspect cookies for specified URLs or across all targets. |
- | `set_cookie` | Set browser cookies with domain, path, and security flags. |
- | `delete_cookie` | Delete a specific cookie by name. |
- | `get_storage` | Read items from `localStorage` or `sessionStorage`. |
- | `set_storage` | Write items to `localStorage` or `sessionStorage`. |
- | `assert_ui` | Verify page URL, title, element visibility, text matches, and absence of console errors. |
- | `save_storage_state` | Export cookies, `localStorage`, and `sessionStorage` into a Playwright-compatible JSON artifact (`electron://artifact/{id}`). |
- | `load_storage_state` | Restore cookies and origin storage state back into the live Electron session for instant auth bypass and state replay. |
- ### 🌐 Network & Downloads (12)
- | Tool | Description |
- | --- | --- |
- | `offline_resilience_check` | **Composite:** Network chaos and fault recovery audit (simulating offline, high latency, or HTTP 500 faults) and Resilience Grade (`A`–`F`). |
- | `network_failure_report` | **Composite:** Gathers failed HTTP requests (status ≥ 400 or network failure), inlines response bodies, and registers an exported HAR artifact. |
- | `get_network_log` | Buffered HTTP requests and responses. Supports status, failure, and URL pattern filters. |
- | `get_response_body` | Fetch raw response body for a completed `requestId` (text or base64). |
- | `export_har` | Export buffered network traffic to an official HAR 1.2 file and register artifact. |
- | `wait_network_idle` | Block until zero network requests are in flight and the network has been quiet. |
- | `network_stub` | Intercept and mock HTTP requests matching a pattern with custom status, headers, or body. |
- | `clear_network_stubs` | Remove all active network interception stubs. |
- | `block_urls` | Block network requests matching wildcard URL patterns. |
- | `set_extra_headers` | Inject custom HTTP headers into all subsequent requests. |
- | `emulate_network` | Emulate offline conditions, added round-trip latency, and download/upload throughput caps. |
- | `get_downloads` | Arm download listeners across all sessions and capture downloaded files without save dialogs. |
- ### 📈 Performance, Profiling & Debugger (16)
- | Tool | Description |
- | --- | --- |
- | `perf_snapshot` | **Composite:** Coordinates CDP tracing, CPU profiling, and code coverage over an interaction or reload, returning an aggregated performance bundle and artifact URIs. |
- | `leak_check` | **Composite:** Memory leak detector measuring DOM node, event listener, document, and heap growth across iterations post-GC. |
- | `get_performance_metrics` | Renderer performance counters (JS heap used/total, DOM node count, layout count, etc.). |
- | `perf_audit` | Lightweight performance audit analyzing LCP, CLS, paint timing, and audit issues. |
- | `get_audit_issues` | Buffered Chromium security, mixed content, and deprecation audit issues. |
- | `start_tracing` / `stop_tracing` | Record and export Perfetto/DevTools JSON timeline traces. |
- | `start_cpu_profile` / `stop_cpu_profile` | Record and export V8 `.cpuprofile` files. |
- | `heap_snapshot` | Capture complete V8 heap snapshot file artifact. |
- | `start_coverage` / `stop_coverage` | Track JavaScript and CSS code coverage and report unused code percentage. |
- | `resolve_stack` | Resolves stack frames back to source snippets; automatically decodes v3 source maps. |
- | `set_breakpoint` / `remove_breakpoint` | Set or clear JavaScript breakpoints by script URL and line number. |
- | `pause` / `resume` | Suspend or resume V8 JavaScript execution via Debugger domain. |
- ### 🛡️ Main Process, Native Mocks, Menus & Security (23)
- | Tool | Description |
- | --- | --- |
- | `ipc_fuzz_and_verify` | **Composite:** IPC security and crash hardening fuzzer probing active handlers with boundary & attack payloads (`null`, `__proto__`, path traversal, oversized buffers). |
- | `mock_electron_api` | Intercept and mock any Electron native module (`dialog`, `shell`, `app`, `clipboard`, `autoUpdater`) with custom return values or async implementations. |
- | `get_mock_calls` | Inspect recorded call history, argument signatures, and timestamps for mocked Electron APIs. |
- | `restore_electron_mocks` | Restore original native Electron implementations and purge mock call records. |
- | `get_application_menu` | Inspect the native `Menu.getApplicationMenu()` tree with roles, labels, enabled/checked states, and accelerator shortcuts. |
- | `click_menu_item` | Programmatically dispatch `.click()` on native application menu items by path (`"File > Save"`), role, or id. |
- | `trigger_shortcut` | Inspect and trigger native global accelerators (`globalShortcut`) in the Electron application. |
- | `get_process_health` | Watchdog monitoring process exits, crashes (`render-process-gone`), window hangs (`unresponsive`), memory RSS/heap, and stderr logs. |
- | `electron_security_audit` | Comprehensive security audit of webPreferences, context isolation, sandboxing, window handlers, navigation guards, and binary fuses. |
- | `ipc_invoke` | Directly invoke a main-process IPC handle channel or emit an IPC event with arguments. |
- | `ipc_schema_inference` | Infer IPC channel contracts, payload types, and auto-generate TypeScript definitions. |
- | `ipc_tap` / `get_ipc_log` | Hook main-process IPC to capture traffic between renderer and main. |
- | `evaluate_main` | Evaluate JavaScript inside the Electron main/Node context (requires `inspectMain`). |
- | `main_state` | Inspect Electron application state: open windows, metrics, versions, and system paths. |
- | `webcontents_topology` | Map BrowserWindows and webContents IDs to their respective CDP targets. |
- | `focus_window` | Show and bring a specific BrowserWindow to the foreground. |
- | `set_window_bounds` | Move or resize an Electron BrowserWindow. |
- | `set_permission` | Programmatically allow or deny permissions (notifications, media, geolocation, etc.). |
- | `get_clipboard` / `set_clipboard` | Read or write text and image data on the OS clipboard. |
- | `print_pdf` | Render the page to a PDF document artifact. |
- | `capture_mhtml` | Save the page DOM, stylesheets, and images into an MHTML archive artifact. |
- ### 🩺 Meta & Diagnostics (11)
- | Tool | Description |
- | --- | --- |
- | `run_script` | **Composite:** Server-side workflow engine with templating (`{{vars}}`, `{{steps[id].result}}`), conditional branching (`if`), step retries, assertions, failure diagnostics, and Playwright codegen. |
- | `triage` | **Composite:** One-shot diagnosis aggregating page state, console errors, network failures, audit issues, log tails, and resolved exception stacks. |
- | `doctor` | Verify environment health, Node/Electron binaries, and test ephemeral port binding. |
- | `diagnose` | Health check across all active sessions, target counts, and buffer sizes. |
- | `clear_buffers` | Reset buffered console messages, network requests, logs, or IPC entries. |
- | `list_targets` | Enumerate all CDP targets (pages, workers, iframes, node). |
- | `emulate` | Override viewport, user agent, geolocation, device scale factor, and color scheme. |
- | `virtual_clock` | Freeze or advance virtual time to test deterministic timers and animations. |
- | `set_console_live` | Stream live console and log messages directly as MCP notifications. |
- | `cdp_command` | Raw CDP escape hatch: execute any `Domain.method` with custom parameters. |
- ---
- ## 📦 Resources & Prompts
- ### 📡 Standard MCP Resources
- Expose real-time state and exported artifacts directly via standard MCP resources:
- - `electron://server` — Server status, version, and host environment.
- - `electron://info` — Active process IDs, target breakdown, and recent error counts.
- - `electron://targets` — Live CDP targets across all connected processes.
- - `electron://artifacts` — Index of all exported screenshots, traces, heap snapshots, and HARs.
- - `electron://artifact/{id}` — Fetch an exported artifact by its ID.
- - `electron://process/{id}` · `electron://logs/{id}` · `electron://console/{id}` · `electron://cdp/{proc}/{target}`
- ### 💬 Built-in MCP Prompts
- Interactive debugging recipes ready for one-click invocation:
- - `debug_blank_window` — Systematically diagnose white/blank renderers.
- - `find_renderer_exception` — Isolate unhandled exceptions, inspect audits, and resolve source stacks.
- - `ui_smoke_check` — End-to-end UI verification: wait, interact, and assert.
- - `attach_and_screenshot` — Discover local apps, attach, and capture visual status.
- - `vision_then_act` — Visual-first agent loop: see, locate semantic target, act, and verify.
- - `ax_then_assert` — Accessibility-first action loop: locate by accessible name and assert state.
- ---
- ## 📚 Agent Recipes
- ### 1. Vision → Act → Verify Loop
- ```json
- // Step 1: Look at the screen and check for errors
- { "name": "vision", "arguments": {} }
- // Step 2: Act and verify in a single turn (captures failure screenshot if assertion fails)
- {
- "name": "act_and_verify",
- "arguments": {
- "action": { "type": "click_ax", "name": "Sign In" },
- "assertion": { "textIncludes": "Welcome back" }
- }
- }
- ```
- ### 2. Secret Redaction in Automation Forms
- ```json
- {
- "name": "type_text",
- "arguments": {
- "selector": "#api-key",
- "text": "{{secret:MY_APP_API_KEY}}"
- }
- }
- ```
- > [!NOTE]
- > Resolves `process.env.MY_APP_API_KEY`, inserts it via CDP, returns `typed: "[REDACTED]"`, and automatically sanitizes the secret from all subsequent logs, console events, and HAR files.
- ### 3. Automated Security Audit
- ```json
- { "name": "electron_security_audit", "arguments": {} }
- ```
- Returns checklist score (0–100), letter grade (A–F), and actionable remediation guidance for `webPreferences` and Electron binary fuses.
- ### 4. IPC Contract Inference
- ```json
- // 1. Arm tap -> 2. Run app interactions -> 3. Infer TypeScript contracts
- { "name": "ipc_schema_inference", "arguments": {} }
- ```
- Generates ready-to-use TypeScript definitions for your preload APIs directly from observed runtime communication.
- ### 5. Multi-Step Workflow Engine & Playwright Codegen (`run_script`)
- Execute complex, multi-action automations server-side in a single MCP roundtrip with variable interpolation, conditional branching, retries, assertion checks, and code generation.
- ```json
- {
- "name": "run_script",
- "arguments": {
- "vars": {
- "targetWorkspace": "workspace-alpha",
- "expectedItems": 3
- },
- "steps": [
- {
- "id": "authenticate",
- "tool": "type_text",
- "args": {
- "selector": "input#token",
- "text": "{{secret:APP_API_TOKEN}}"
- },
- "expect": { "status": "success" }
- },
- {
- "id": "switch_workspace",
- "tool": "click",
- "args": { "selector": "button.workspace-switch" },
- "retry": { "retries": 3, "delayMs": 250 }
- },
- {
- "id": "check_banner",
- "tool": "eval_js",
- "args": { "expression": "Boolean(document.querySelector('.promo-modal'))" }
- },
- {
- "id": "dismiss_banner",
- "if": "{{steps.check_banner.result.value}} == true",
- "tool": "click",
- "args": { "selector": ".promo-modal .close-btn" }
- },
- {
- "id": "verify_workspace_state",
- "tool": "eval_js",
- "args": {
- "expression": "({ active: document.querySelector('#current-ws').textContent.trim(), count: document.querySelectorAll('.item').length })"
- },
- "expect": {
- "js": "result.value.active === 'workspace-alpha' && result.value.count >= 3"
- }
- }
- ],
- "exportAs": "playwright"
- }
- }
- ```
- #### Capabilities & Options
- | Feature | Syntax / Option | Purpose |
- | --- | --- | --- |
- | **Variables & Context** | `{{vars.key}}` | Reference values from the script's `vars` object with preserved primitive types (strings, numbers, booleans, objects). |
- | **Step Dependencies** | `{{steps.id.result.path}}` | Pass outputs, IDs, or tokens computed in earlier steps directly into subsequent tool arguments. |
- | **Environment & Secrets** | `{{env.KEY}}` · `{{secret:KEY}}` | Inject process environment variables; secrets are automatically masked in logs, console events, and outputs as `[REDACTED]`. |
- | **Conditional Branching** | `if: "{{steps.check.result.open}} == true"` | Skips step execution unless condition evaluates to true (`==`, `!=`, `<`, `>`, `&&`, `||`). |
- | **Expectation Assertions** | `expect: { contains, equals, status, js }` | Validates step outcome; custom `js` expressions evaluate against `result` to verify app invariants. |
- | **Automatic Retries** | `retry: { retries: 3, delayMs: 250 }` | Automatically retries flaky operations with exponential backoff before failing. |
- | **Failure Diagnostics** | *Automated* | If a step fails, captures viewport screenshot artifact (`electron://artifact/{id}`), console errors, and network errors. |
- | **Playwright Codegen** | `exportAs: "playwright"` | Generates a standalone, runnable Playwright `_electron` test script (`.spec.ts`) reflecting the executed sequence. |
- <details>
- <summary><b>View Generated Playwright Codegen Output</b></summary>
- ```typescript
- import { test, expect, _electron as electron } from "@playwright/test";
- test("executed script workflow", async () => {
- const electronApp = await electron.launch({ args: ["."] });
- const window = await electronApp.firstWindow();
- // Step: authenticate
- await window.locator("input#token").fill(process.env.APP_API_TOKEN || "");
- // Step: switch_workspace
- await window.locator("button.workspace-switch").click();
- // Step: dismiss_banner
- await window.locator(".promo-modal .close-btn").click();
- // Step: verify_workspace_state
- const evalResult = await window.evaluate("({ active: document.querySelector('#current-ws').textContent.trim(), count: document.querySelectorAll('.item').length })");
- expect(evalResult).toBeDefined();
- await electronApp.close();
- });
- ```
- </details>
- ### 6. Ref Locators & Set-of-Marks Visual Prompting
- Inspect accessibility targets with compact refs (`e1`, `e2`) and drive interactions without fragile CSS selectors:
- ```json
- // 1. Take snapshot with Set-of-Marks badges in the screenshot
- { "name": "vision", "arguments": { "markElements": true } }
- // 2. Click directly by ref token
- { "name": "click", "arguments": { "ref": "e3" } }
- // 3. Type text into ref
- { "name": "type_text", "arguments": { "ref": "e4", "text": "Hello Desktop!" } }
- ```
- ### 7. Native Electron API Mocking (Dialogs, Shell, Clipboard)
- Bypass OS file dialogs, external URL opens, or update checks during automated test runs:
- ```json
- // 1. Mock dialog.showOpenDialog to return test fixtures
- {
- "name": "mock_electron_api",
- "arguments": {
- "module": "dialog",
- "method": "showOpenDialog",
- "returns": { "canceled": false, "filePaths": ["/fixtures/document.pdf"] }
- }
- }
- // 2. Mock shell.openExternal
- {
- "name": "mock_electron_api",
- "arguments": {
- "module": "shell",
- "method": "openExternal",
- "returns": true
- }
- }
- // 3. Inspect tracked invocations
- { "name": "get_mock_calls", "arguments": { "module": "shell", "method": "openExternal" } }
- // 4. Restore original implementation
- { "name": "restore_electron_mocks", "arguments": { "module": "shell", "method": "openExternal" } }
- ```
- ### 8. Native Application Menu & Accelerator Trigger
- Automate native OS menus and global keyboard shortcuts:
- ```json
- // 1. Inspect the full native menu tree
- { "name": "get_application_menu", "arguments": {} }
- // 2. Click menu item by path or role
- { "name": "click_menu_item", "arguments": { "path": "File > Save" } }
- // 3. Dispatch an Electron accelerator directly
- { "name": "trigger_shortcut", "arguments": { "accelerator": "CommandOrControl+Shift+P" } }
- ```
- ### 9. Process Health Watchdog & Crash Diagnostics
- ```json
- { "name": "get_process_health", "arguments": {} }
- ```
- Returns real-time status (`"healthy"`, `"unresponsive"`, or `"crashed"`), tracking OOM terminations, child process failures, window hangs, and memory metrics.
- ### 10. Storage State Snapshot & Auth Replay
- Save full session state (cookies, localStorage, sessionStorage) into Playwright-compatible storage state artifacts to bypass repeated login flows across tests:
- ```json
- // 1. Export storage state to an artifact
- { "name": "save_storage_state", "arguments": {} }
- // 2. Restore state into any new Electron session
- {
- "name": "load_storage_state",
- "arguments": {
- "state": { "cookies": [...], "origins": [...] }
- }
- }
- ```
- ### 11. One-Shot Bug Repro Bundle & Issue Generator (`repro_bundle`)
- Package a complete, self-contained zip archive containing viewport screenshot, full MHTML DOM archive, HAR network replay, source-mapped console errors, stderr tail, health metrics, and a GitHub-ready Markdown issue report in one turn:
- ```json
- {
- "name": "repro_bundle",
- "arguments": {
- "notes": "Regression on checkout flow after OAuth upgrade"
- }
- }
- ```
- Returns `artifactUri: "electron://artifact/..."`, destination path, and the complete markdown summary ready to paste into GitHub issues or Jira.
- ### 12. Smart Multi-Field Accessible & Secret Form Solver (`fill_form`)
- Fill complete multi-input forms in a single tool call from either a key-value dictionary or structured field specs:
- ```json
- {
- "name": "fill_form",
- "arguments": {
- "fields": {
- "Username or Email": "developer@example.com",
- "Password": "{{secret:APP_PASSWORD}}",
- "Environment": "Staging",
- "Remember Me": true
- },
- "submit": true,
- "expect": {
- "textIncludes": "Welcome back"
- }
- }
- }
- ```
- Resolves fields via accessibility tree labels, ARIA attributes, placeholders, or refs (`e1`), resolves secrets securely, selects dropdown options, toggles checkboxes, clicks submit, and verifies post-submit UI assertions.
- ### 13. Network Chaos & Resilience Scorecard (`offline_resilience_check`)
- Simulate real-world network failure conditions (offline, latency, or HTTP 500) during interaction, monitor app health and error bursts, restore network, and compute an executive Resilience Grade (A–F):
- ```json
- {
- "name": "offline_resilience_check",
- "arguments": {
- "faultType": "offline",
- "durationMs": 1500,
- "action": { "type": "click", "selector": "#save-btn" }
- }
- }
- ```
- ### 14. Responsive Theme & Viewport Matrix Sweep (`responsive_theme_matrix`)
- Audit how layouts adapt across color schemes (`light`, `dark`) and viewport sizes, catching horizontal scrollbar leaks (`scrollWidth > innerWidth`):
- ```json
- {
- "name": "responsive_theme_matrix",
- "arguments": {
- "themes": ["light", "dark"],
- "viewports": [
- { "width": 800, "height": 600, "name": "compact" },
- { "width": 1280, "height": 800, "name": "desktop" }
- ]
- }
- }
- ```
- ### 15. IPC Security & Crash Hardening Fuzzer (`ipc_fuzz_and_verify`)
- Harden renderer-to-main IPC communication against malicious or malformed payloads (`null`, prototype pollution, path traversal, oversized buffers) and verify process crash resistance:
- ```json
- {
- "name": "ipc_fuzz_and_verify",
- "arguments": {
- "iterations": 6
- }
- }
- ```
- ---
- ## 📋 Changelog & Releases
- | Version | Release Highlights | Test Suite |
- | :--- | :--- | :--- |
- | **v1.15.1** | **Security & Client Startup Fixes**: Path validation for `run_script` / `save_storage_state` (`validateOutputPath`, prevents CWE-22 arbitrary file write), and removal of broken `postinstall` script fixing `npx` / Copilot / Cursor handshake exit code 1. **111 tools**. | 142 unit · 111 smoke |
- | **v1.15.0** | **Composite Superpowers & Resilience Workflows**: One-Shot Bug Repro Bundle (`repro_bundle`), Smart Accessible & Secret Form Solver (`fill_form`), Network Chaos Resilience Scorecard (`offline_resilience_check`), Responsive Theme Sweep (`responsive_theme_matrix`), IPC Security Fuzzer (`ipc_fuzz_and_verify`). Pure Node zero-dependency PKZip generator. **111 tools**. | 140 unit · 111 smoke |
- | **v1.14.0** | **Ref Locators & Set-of-Marks** (`ref: "e1"`, `markElements: true`), **Native Electron API Mocking** (`mock_electron_api`, `get_mock_calls`, `restore_electron_mocks`), **Native Application Menu Driver** (`get_application_menu`, `click_menu_item`, `trigger_shortcut`), **Process Health Watchdog** (`get_process_health`), **Storage State Save & Load** (`save_storage_state`, `load_storage_state`). **106 tools**. | 135 unit · 106 smoke |
- | **v1.13.0** | **Server-Side Workflow Engine & Codegen** (`run_script` with context variables, conditional branching, expectation assertions, retries, failure diagnostics, and Playwright test codegen). **97 tools**. | 130 unit · 97 smoke |
- | **v1.12.0** | **Runtime Security Audit** (`electron_security_audit`), **Zero-Leak Secret Redaction** (`{{secret:VAR}}`), **IPC Schema Inference** (`ipc_schema_inference`), **Memory Leak Hunter** (`leak_check`), **Source Maps** (`resolve_stack`), **Composite Workflows** (`act_and_verify`, `triage`, `network_failure_report`, `perf_snapshot`). **96 tools**. | 125 unit · 96 smoke |
- | **v1.11.0** | **Tool Annotations** (`readOnlyHint`, `destructiveHint`), **Optional `processId`**, **Artifacts System** (`electron://artifacts`), **Network Log Filtering**, **DOM Guard**, `llms.txt`. **88 tools**. | 120 unit · 88 smoke |
- > [!TIP]
- > Complete historical release notes, API migration notes, and dependency updates are tracked in [**`CHANGELOG.md`**](./CHANGELOG.md).
- ---
- ## 🧯 Troubleshooting
- | Symptom | Solution |
- | --- | --- |
- | `Electron failed to install correctly` | Run `npm run ensure-electron` to verify and download the platform binary. |
- | `Process not found` | Omit `processId` when debugging a single app; the server resolves it automatically. |
- | Terminal hangs on `node build/index.js` | Normal: the server communicates over stdio JSON-RPC. Spawn it from your MCP client. |
- | Main-process tools fail | Launch the app with `inspectMain: true` to open the Node inspector port. |
- | Port in use / WSAEACCES on Windows | The server dynamically probes and selects ephemeral bindable ports to avoid Hyper-V/WSL conflicts. |
- ---
- ## 📜 Development & Verification
- ```bash
- npm test # Run build, 140 unit tests, and full 111-tool smoke suite
- npm run doctor # Verify environment health and port binding
- npm run sync:readme # Automatically synchronize badge counts with registered tools
- ```
- ---
- ## 📄 License
- [ISC](./LICENSE) © Electron Debug MCP contributors
- <div align="center">
- <img src="assets/logo.svg" width="48" height="48" alt="Electron Debug MCP" /><br/>
- <sub>Built for autonomous agents that need eyes — and hands — inside Electron.</sub>
- </div>
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.