Electron MCP Server

🚀 Electron Debug MCP Server

Electron Debug MCP Server is a tool for managing and debugging Electron applications. It offers rich features through the Model Context Protocol (MCP).

🚀 Quick Start

Electron Debug MCP Server is a tool designed to manage and debug Electron applications, leveraging the Model Context Protocol (MCP) to offer a wide range of features.

✨ Features

• Start and Stop: Initiate new Electron processes and terminate running ones.
• Monitor Processes: List all running Electron processes along with their detailed information.
• Log Management: Retrieve the log records of specific processes.
• Debug Targets: List available debug targets.
• CDP Integration: Deeply integrate with the Chrome DevTools Protocol to provide powerful debugging capabilities.

📦 Installation

1. Clone the repository:

   git clone https://github.com/your-repository/electron-mcp-server.git
   cd electron-mcp-server
   

2. Install dependencies:

   npm install
   

💻 Usage Examples

Start the Server

npm run start

This command will start the MCP server, enabling communication via standard input and output.

Connect to the Server

The MCP server communicates through standard input and output. Clients can connect using:

• The MCP client library.
• Direct connection to stdin/stdout.
• Tools that support MCP.

📚 Documentation

Resource Endpoints

Available Operations

Chrome DevTools Protocol Integration

List Available Targets

GET electron://targets

This command returns the debug targets of all running Electron processes.

Check a Specific Target

GET electron://cdp/{processId}/{targetId}

This command provides information about a specific target and the available CDP domains.

Execute a CDP Command

GET electron://cdp/{processId}/{targetId}/{domain}/{command}

Basic Usage

// Example request using the MCP client
const response = await mcpClient.readResource({
  uri: "electron://operation/start",
  content: JSON.stringify({
    appPath: "C:\\path\\to\\your\\electron\\app",
    debugPort: 9222  // Optional debug port
  })
});

Advanced Usage

// Get detailed information about a specific process
const processId = "electron-1234567890";
const infoResponse = await mcpClient.readResource({
  uri: `electron://process/${processId}`
});

// Execute JavaScript in the page
const response = await mcpClient.readResource({
  uri: "electron://operation/evaluate",
  content: JSON.stringify({
    expression: "console.log('Hello, World!');"
  })
});

🔧 Technical Details

Development

1. Clone the repository:

git clone https://github.com/your-repository/electron-mcp-server.git
cd electron-mcp-server
npm install

2. Start the development server:

npm run dev

Contribution

Contributions are welcome! Please refer to CONTRIBUTING.md.

📄 License

MIT License

With this tool, developers can manage and debug Electron applications more efficiently.