Skip to content

AI-powered visual debugging for React and Vue via MCP (Model Context Protocol) and ACP (Agent Client Protocol)

Notifications You must be signed in to change notification settings

mcpc-tech/dev-inspector-mcp

Repository files navigation

DevInspector Logo

@mcpc-tech/unplugin-dev-inspector-mcp

npm version npm downloads

AI-powered visual debugging for React, Vue, Svelte, SolidJS, Preact & Next.js via MCP and ACP.

DevInspector connects your web app directly to your AI agent. Click any element to instantly send its source code, style, and network context to the AI for analysis and fixing.

Works with any MCP-compatible AI client. Supports ACP agents: Claude Code, Codex CLI, Gemini CLI, OpenCode, and more.

πŸ“‘ Table of Contents

🎬 Demo Video

Demo Video

πŸ‘‰ Watch the demo: https://www.youtube.com/shorts/TCt2oOtPS_k

πŸ“’ Social Media

🐦 Twittter/X Post: https://x.com/yaoandyan/status/1995082020431753600

πŸ‘₯ Team

🀝 Sponsors & Integrations

This project uses the following sponsor APIs and platforms:

  • Anthropic - Claude API for MCP integration testing and AI-powered debugging capabilities
  • Gradio - @gradio/client for connecting to Gradio-powered APIs in the demo app

Demo: MCP-powered visual debugging in action

Key Features

🎯 Visual Context

Click any element to instantly send its source code location, computed styles, and DOM hierarchy to AI. No more explaining "it's the blue button in the header".

πŸ› οΈ Full DevTools Access

AI can access Chrome DevTools to analyze network requests, console logs, and performance metrics. It sees what you see.

πŸ€– Multi-Agent Workflow

Switch between agents (Claude Code, Goose) and track their debugging progress visually with step-by-step status updates.

Quick Start

Installation

# npm
npm i -D @mcpc-tech/unplugin-dev-inspector-mcp

# pnpm
pnpm add -D @mcpc-tech/unplugin-dev-inspector-mcp

# yarn
yarn add -D @mcpc-tech/unplugin-dev-inspector-mcp

Add DevInspector to your project:

⚑ Automated Setup (Recommended)

Run the setup command to automatically configure your vite.config.ts, webpack.config.js, or next.config.js:

npx @mcpc-tech/unplugin-dev-inspector-mcp setup

Options:

  • --dry-run - Preview changes without applying them
  • --config <path> - Specify config file path (auto-detect by default)
  • --bundler <type> - Specify bundler type: vite, webpack, nextjs
  • --no-backup - Skip creating backup files
  • --help - Show help message

Examples:

# Preview changes before applying
npx @mcpc-tech/unplugin-dev-inspector-mcp setup --dry-run

# Setup specific config file
npx @mcpc-tech/unplugin-dev-inspector-mcp setup --config vite.config.ts

# Setup for specific bundler
npx @mcpc-tech/unplugin-dev-inspector-mcp setup --bundler vite

This will:

  • Detect your bundler configuration
  • Add the necessary import
  • Add the plugin to your configuration
  • Create a backup of your config file

Manual Configuration

If you prefer to configure it manually:

Vite

// vite.config.ts
+import DevInspector from '@mcpc-tech/unplugin-dev-inspector-mcp';
 import react from '@vitejs/plugin-react'; // or vue(), svelte(), solid(), preact()

 export default {
   plugins: [
+    DevInspector.vite({
+      enabled: true,
       showInspectorBar: true, // Default: true. Set to false to hide the UI.
+      autoOpenBrowser: false, // Default: false. Automatically open browser when server starts.
     }),
     react(), // or vue(), svelte(), solid(), preact()
   ],
 };

⚠️ Plugin order matters: Place DevInspector.vite() before react(), vue(), svelte(), solid(), or preact(). Otherwise source locations may show unknown:0:0.

For Non-HTML Projects (Miniapps, Library Bundles)

If your project doesn't use HTML files (e.g., miniapp platforms that only bundle JS):

// vite.config.ts
DevInspector.vite({
  enabled: true,
  autoInject: false  // Disable HTML injection
})
// main.ts or app entry point
import 'virtual:dev-inspector-mcp';  // ← Add this import

βœ… Zero Production Impact: This import is automatically removed in production builds via tree-shaking. The entire dev-inspector code is wrapped in if (import.meta.env.DEV) guards, which bundlers statically replace with false during production builds.

Custom Virtual Module Name

If virtual:dev-inspector-mcp conflicts with your project, you can customize it:

// vite.config.ts
DevInspector.vite({
  enabled: true,
  autoInject: false,
  virtualModuleName: 'virtual:my-custom-inspector'  // ← Custom name
})
// main.ts
import 'virtual:my-custom-inspector';  // ← Use your custom name

Webpack

// webpack.config.js
+const DevInspector = require('@mcpc-tech/unplugin-dev-inspector-mcp');

module.exports = {
  plugins: [
+    DevInspector.webpack({
+      enabled: true,
+    }),
  ],
};

Next.js

// next.config.ts
+import DevInspector from '@mcpc-tech/unplugin-dev-inspector-mcp';

const nextConfig: NextConfig = {
+  webpack: (config) => {
+    config.plugins.push(
+      DevInspector.webpack({
+        enabled: true,
+      })
+    );
+    return config;
+  },
};

export default nextConfig;

Then add to your root layout:

// app/layout.tsx
import { DevInspector } from "@mcpc-tech/unplugin-dev-inspector-mcp/next";

export default function RootLayout({ children }) {
  return (
    <html>
      <body>
        <DevInspector />
        {children}
      </body>
    </html>
  );
}

πŸ’‘ Note: Webpack and Next.js use a standalone server on port 8888. Run next dev --webpack for Webpack mode (Next.js 16+ defaults to Turbopack).

Framework Support

βœ… Fully Supported

  • React - .jsx and .tsx files (Vite, Webpack, Next.js)
  • Vue - .vue single-file components (Vite, Webpack)
  • Svelte - .svelte components (Vite, Webpack)
  • SolidJS - .jsx and .tsx files (Vite, Webpack)
  • Preact - .jsx and .tsx files (Vite, Webpack)
  • Next.js - React with Webpack mode

🚧 In Progress

  • Angular - Support coming soon

Configuration

Auto-Update MCP Config

The plugin automatically updates MCP configuration files for detected editors when the dev server starts. This saves you from manually configuring MCP endpoints.

Supported editors: Cursor, VSCode, Windsurf, Claude Code, Antigravity

// vite.config.ts
DevInspector.vite({
  // Auto-detect and update (default: true)
  updateConfig: true,
  
  // Or specify editors manually
  updateConfig: ['cursor', 'vscode'],
  
  // Or disable
  updateConfig: false,
  
  // Server name in MCP config (default: 'dev-inspector')
  updateConfigServerName: 'my-app-inspector',
})

Custom editors: For non-standard editors, use customEditors:

DevInspector.vite({
  customEditors: [
    {
      id: 'my-editor',
      name: 'My Editor',
      configPath: '~/.my-editor',        // absolute, ~/relative, or project-relative
      configFileName: 'mcp.json',
      serverUrlKey: 'url',               // default: 'url'
      configFormat: 'mcpServers',        // 'mcpServers' or 'servers' (vscode-style)
    },
  ],
})

Custom Agents

This plugin uses the Agent Client Protocol (ACP) to connect with AI agents.

⏱️ Note: Initial connection may be slow as agents are launched via npx (downloads packages on first run).

Default agents: View configuration β†’

You can customize available AI agents and set a default agent:

// vite.config.ts
export default {
  plugins: [
    DevInspector.vite({
      enabled: true,
      // Custom agents (will be merged with default properties)
      agents: [
        {
          name: "Claude Code", // Matches default - auto-fills icon and env
          command: "npx",
          args: ["-y", "@zed-industries/claude-code-acp"],
        },
        {
          name: "My Custom Agent",
          command: "my-agent-cli",
          args: ["--mode", "acp"],
          env: [{ key: "MY_API_KEY", required: true }],
          meta: { icon: "https://example.com/icon.svg" }
        }
      ],
      // Set default agent to show on startup
      defaultAgent: "Claude Code"
    }),
  ],
};

Key Features:

  • Custom agents with the same name as default agents automatically inherit missing properties (icons, env)
  • You can override just the command/args while keeping default icons
  • If no custom agents provided, defaults are: Claude Code, Codex CLI, Gemini CLI, Kimi CLI, Goose, OpenCode

What It Does

Click element β†’ Describe issue β†’ AI analyzes β†’ Get fix

  1. Click any UI element to capture context (source, styles, DOM)
  2. Describe what's wrong or ask a question about the element
  3. AI diagnoses using Chrome DevTools integration
  4. Get intelligent solutions through natural conversation

Examples:

  • "Why is this button not clickable?" β†’ AI checks pointer-events, z-index, overlays
  • "This API call is failing" β†’ AI analyzes network requests, timing, responses
  • "Where is this component?" β†’ Jump to source file and line number

Two Workflow Modes

DevInspector offers two ways to interact with your AI, depending on your preference:

1. Editor Mode

Best for: Code-heavy tasks, refactoring, and maintaining flow.

  • How it works: You use your IDE's AI assistant (Cursor, Windsurf, Copilot).
  • The Flow: Click an element in the browser -> The context (source, props, styles) is sent to your Editor via MCP -> You ask your Editor to fix it.
  • Why: Keeps you in your coding environment.

2. Inspector Bar Mode (Recommended)

Best for: Quick fixes, visual tweaks, or if you don't use an AI editor.

  • How it works: You use the floating "Inspector Bar" directly in the browser.
  • The Flow: Click "Ask AI" in the browser -> Select an agent (e.g., Claude Code, Custom Script) -> The agent runs in your terminal but interacts with the browser overlay.
  • Why: No context switching. Great for "what is this?" questions or network debugging.

MCP Tools

capture_element_context

Activates visual selector. Returns source location, DOM hierarchy, styles, dimensions, and user notes.

list_inspections

Shows all inspections with ID, element details, notes, and status (pending/in-progress/completed/failed).

update_inspection_status

Updates inspection status with optional progress steps.

Parameters: status, message (required for completed/failed), progress, inspectionId (optional)

execute_page_script

Executes JavaScript in browser context. Access to window, document, React/Vue instances, localStorage.

chrome_devtools

Agentic tool for Chrome DevTools access. Provides network inspection, console logs, performance metrics, element interaction, and more.

MCP Prompts

capture_element

Capture and analyze UI element context.

view_inspections

View all pending, in-progress, and completed inspections.

launch_chrome_devtools

Opens Chrome with DevTools API. Unlocks network analysis, console logs, performance metrics.

Parameter: url (defaults to dev server)

πŸ’‘ Optional if Chrome is already open. Use when you need to launch a new Chrome instance.

get_network_requests

List network requests or get details of a specific one. Always refreshes the list first.

Parameter: reqid (optional) - If provided, get details for that request. If omitted, just list all requests.

get_console_messages

List console messages or get details of a specific one. Always refreshes the list first.

Parameter: msgid (optional) - If provided, get details for that message. If omitted, just list all messages.

Architecture

For a deep dive into how the MCP context, CMCP library, and Puppet binding mechanism work together, see the Architecture Documentation.

Key concepts:

  • Hub-and-spoke model: Vite dev server acts as central hub managing multiple client connections
  • CMCP bidirectional execution: Server defines tool schemas, browser client provides implementations
  • Puppet binding: Enables Chrome DevTools ↔ Inspector message passthrough
  • Dynamic rebinding: Automatic connection recovery after browser refresh

License

MIT

About

AI-powered visual debugging for React and Vue via MCP (Model Context Protocol) and ACP (Agent Client Protocol)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages