🚀 Electron Debug MCP 服务器

一个强大的 Model Context Protocol (MCP) 服务器，用于调试具有深度 Chrome DevTools Protocol 集成的 Electron 应用程序。

📋 目录

• 概述
• 特性
• 安装
• 使用
• 资源端点
• Chrome DevTools Protocol 集成
• 示例
• 开发
• 贡献
• 许可证

🔍 概述

Electron Debug MCP Server 提供了 Model Context Protocol (MCP) 和 Electron 应用程序之间的桥梁，通过标准化的 API 实现高级调试功能。 它允许您以编程方式启动、监视、调试和控制 Electron 应用程序，并与 Chrome DevTools Protocol 深度集成，以实现高级调试功能。

✨ 特性

🔄 核心功能

• 进程管理
  • 🚀 启动启用调试的 Electron 应用程序
  • 🛑 停止正在运行的 Electron 进程
  • 📋 列出所有活动的 Electron 进程
  • 📊 监视进程状态和日志

🔍 调试能力

• Chrome DevTools Protocol 集成
  • 🎯 发现并连接到调试目标
  • 🧩 跨域执行 CDP 命令
  • 📝 在页面上下文中评估 JavaScript
  • 🔄 重新加载页面或整个应用程序
  • ⏯️ 暂停和恢复 JavaScript 执行

📡 资源访问

• 结构化资源端点
  • 📊 所有正在运行的 Electron 进程的概述
  • 📝 特定进程的详细调试信息
  • 📜 访问进程日志
  • 🎯 可用调试目标的列表
  • 🔍 直接 CDP 访问特定目标

📥 安装

# 克隆仓库
git clone https://github.com/yourusername/electron-mcp-server.git

# 导航到项目目录
cd electron-mcp-server

# 安装依赖
npm install

# 构建项目
npm run build

🚀 使用

启动服务器

npm run start

这将使用 stdio 启动 MCP 服务器进行通信。

连接到服务器

MCP 服务器使用 stdio 进行通信，因此客户端需要使用 Model Context Protocol 进行连接。 您可以：

• 使用 MCP 客户端库
• 直接通过 stdin/stdout 连接
• 使用支持 MCP 的工具

📡 资源端点

服务器公开以下资源端点：

资源	描述
electron://info	所有正在运行的 Electron 进程的概述
electron://process/{id}	特定进程的详细调试信息
electron://logs/{id}	访问特定进程的日志
electron://targets	所有可用调试目标的列表
electron://cdp/{processId}/{targetId}	特定目标的 CDP 访问
electron://operation/{operation}	控制 Electron 应用程序的操作

可用操作

操作	描述
start	启动 Electron 应用程序
stop	停止正在运行的 Electron 进程
list	列出所有正在运行的 Electron 进程
reload	重新加载特定页面或应用程序
evaluate	在页面上下文中执行 JavaScript
pause	暂停 JavaScript 执行
resume	恢复 JavaScript 执行

🔍 Chrome DevTools Protocol 集成

服务器与 Chrome DevTools Protocol 集成，以提供深度调试功能：

列出可用目标

GET electron://targets

返回所有正在运行的 Electron 进程中的所有可用调试目标。

检查特定目标

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

提供有关目标和可用 CDP 域的信息。

执行 CDP 命令

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

示例：

• electron://cdp/electron-123456/page-1/Page/reload - 重新加载页面
• electron://cdp/electron-123456/page-1/Runtime/evaluate - 评估 JavaScript
• electron://cdp/electron-123456/page-1/Debugger/pause - 暂停执行

📝 示例

启动 Electron 应用程序

// 示例请求（使用 MCP 客户端）
const response = await mcpClient.readResource({
  uri: "electron://operation/start",
  content: JSON.stringify({
    appPath: "C:\\path\\to\\your\\electron\\app",
    debugPort: 9222  // 可选的调试端口
  })
});

获取调试信息

// 获取有关特定应用程序的详细信息
const processId = "electron-1234567890";
const infoResponse = await mcpClient.readResource({
  uri: `electron://process/${processId}`
});

在页面中执行 JavaScript

// 在页面中执行 JavaScript
const evalResponse = await mcpClient.readResource({
  uri: `electron://cdp/electron-123456/page-1/Runtime/evaluate`,
  content: JSON.stringify({
    expression: "document.title",
    returnByValue: true
  })
});

🛠️ 开发

项目结构

electron-mcp-server/
├── src/
│   ├── index.ts         # 主要服务器实现
│   └── types/           # TypeScript 类型定义
├── build/               # 编译后的 JavaScript 输出
├── package.json         # 项目依赖和脚本
└── tsconfig.json        # TypeScript 配置

构建项目

npm run build

在开发模式下运行

npm run dev

🤝 贡献

欢迎贡献！ 请随时提交 Pull Request。

1. Fork 仓库
2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开 Pull Request

📄 许可证

该项目根据 ISC 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。

---

使用 ❤️ 通过 TypeScript、Electron 和 Chrome DevTools Protocol 构建。