Chrome Debug MCP

🚀 Chrome Debugging Guide

This guide provides a comprehensive introduction to the Chrome debugging tool, including installation steps, quick start instructions, usage examples, and more.

🚀 Quick Start

Initialize Configuration

Create a config.js file in the root directory of your project:

// config.js
module.exports = {
  port: 9229, // Custom debugging port
  chromePath: 'C:/Program Files/Google/Chrome/Application/chrome.exe' // Chrome installation path
};

Start the Debugging Server

Run the following command in the terminal to start the debugging service:

node index.js

✨ Features

• Multiple Installation Methods: Supports both npm installation and manual installation.
• Customizable Configuration: Allows users to customize the debugging port and Chrome installation path.
• Rich Usage Examples: Provides basic usage examples and examples for debugging Chrome instances.
• Diverse Debugging Commands: Offers commands to start new sessions and connect to existing sessions.

📦 Installation

Install via npm

You can use npm, the Node.js package manager, to install the project:

npm install chrome-debug

Manual Installation

If you don't want to use npm, you can directly download the source code from GitHub and extract it to your project directory.

💻 Usage Examples

Basic Usage

const { Debugger } = require('chrome-debug');

// Initialize the debugger
const debugger = new Debugger({
  port: 9229, // Custom port
  configPath: 'config.js' // Configuration file path
});

// Start the debugging service
debugger.start().then(() => {
  console.log('Debugging server has been started');
});

Debug a Chrome Instance

const { chrome } = require('@modelcontextprotocol/chrome-remote-interface');

async function main() {
  const chrome = await chrome.connect({
    url: 'ws://localhost:9229',
    target: {
      browserContextId: 0
    }
  });

  // Example operation: Get the title of the current page
  const title = await chrome.Runtime.getTitle();
  console.log('Page title:', title);

  // Close the Chrome instance
  await chrome.close();
}

main().catch(console.error);

📚 Documentation

Debugging Commands

Start a New Session

chrome-debug --start --port=9230

Connect to an Existing Session

chrome-debug --connect --url=http://localhost:9230

Project Dependencies

This project uses the following open - source libraries:

• Puppeteer - Chrome automation library
• Chrome DevTools Protocol - Chrome debugging tool protocol client
• @modelcontextprotocol/sdk - MCP SDK for server implementation

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.

🔗 Contribution Guide

For detailed information on contributing, please refer to Contributing.md.

🙏 Acknowledgments

Thanks for the support of the following resources and communities:

• Chrome DevTools Protocol
• Greasemonkey API
• Model Context Protocol