Skip to content

Commit f67f6be

Browse files
committed
feat: Add automated setup instructions, SolidJS support, and framework support section to README, and bump package version.
1 parent 9209830 commit f67f6be

File tree

2 files changed

+62
-19
lines changed

2 files changed

+62
-19
lines changed

packages/unplugin-dev-inspector/README.md

Lines changed: 61 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,13 @@
1-
---
2-
title: Inspect Web Mcp
3-
emoji: 😻
4-
colorFrom: purple
5-
colorTo: red
6-
sdk: gradio
7-
sdk_version: 5.49.1
8-
app_file: app.py
9-
pinned: false
10-
short_description: AI-powered web debugging with visual element inspection
11-
tags:
12-
- building-mcp-track-creative
13-
- mcp-in-action-track-creative
14-
---
1+
<p align="center">
2+
<img src="./assets/logo.svg" alt="DevInspector Logo" width="200" height="200" />
3+
</p>
154

165
# @mcpc-tech/unplugin-dev-inspector-mcp
176

187
[![npm version](https://img.shields.io/npm/v/@mcpc-tech/unplugin-dev-inspector-mcp.svg)](https://www.npmjs.com/package/@mcpc-tech/unplugin-dev-inspector-mcp)
198
[![npm downloads](https://img.shields.io/npm/dm/@mcpc-tech/unplugin-dev-inspector-mcp.svg)](https://www.npmjs.com/package/@mcpc-tech/unplugin-dev-inspector-mcp)
209

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

2312
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.
2413

@@ -29,6 +18,7 @@ Works with any MCP-compatible AI client. Supports ACP agents: **Claude Code**, *
2918
- [Demo Video](#-demo-video)
3019
- [Key Features](#-key-features)
3120
- [Quick Start](#-quick-start)
21+
- [Framework Support](#framework-support)
3222
- [Configuration](#-configuration)
3323
- [How It Works](#-what-it-does)
3424
- [Workflow Modes](#-two-workflow-modes)
@@ -88,12 +78,49 @@ yarn add -D @mcpc-tech/unplugin-dev-inspector-mcp
8878

8979
Add DevInspector to your project:
9080

81+
### ⚡ Automated Setup (Recommended)
82+
83+
Run the setup command to automatically configure your `vite.config.ts`, `webpack.config.js`, or `next.config.js`:
84+
85+
```bash
86+
npx @mcpc-tech/unplugin-dev-inspector-mcp setup
87+
```
88+
89+
**Options:**
90+
- `--dry-run` - Preview changes without applying them
91+
- `--config <path>` - Specify config file path (auto-detect by default)
92+
- `--bundler <type>` - Specify bundler type: vite, webpack, nextjs
93+
- `--no-backup` - Skip creating backup files
94+
- `--help` - Show help message
95+
96+
**Examples:**
97+
```bash
98+
# Preview changes before applying
99+
npx @mcpc-tech/unplugin-dev-inspector-mcp setup --dry-run
100+
101+
# Setup specific config file
102+
npx @mcpc-tech/unplugin-dev-inspector-mcp setup --config vite.config.ts
103+
104+
# Setup for specific bundler
105+
npx @mcpc-tech/unplugin-dev-inspector-mcp setup --bundler vite
106+
```
107+
108+
This will:
109+
- Detect your bundler configuration
110+
- Add the necessary import
111+
- Add the plugin to your configuration
112+
- Create a backup of your config file
113+
114+
### Manual Configuration
115+
116+
If you prefer to configure it manually:
117+
91118
### Vite
92119

93120
```diff
94121
// vite.config.ts
95122
+import DevInspector from '@mcpc-tech/unplugin-dev-inspector-mcp';
96-
import react from '@vitejs/plugin-react'; // or vue(), svelte(), preact()
123+
import react from '@vitejs/plugin-react'; // or vue(), svelte(), solid(), preact()
97124

98125
export default {
99126
plugins: [
@@ -102,12 +129,12 @@ Add DevInspector to your project:
102129
showInspectorBar: true, // Default: true. Set to false to hide the UI.
103130
+ autoOpenBrowser: false, // Default: false. Automatically open browser when server starts.
104131
}),
105-
react(), // or vue(), svelte(), preact()
132+
react(), // or vue(), svelte(), solid(), preact()
106133
],
107134
};
108135
```
109136

110-
> ⚠️ **Plugin order matters:** Place `DevInspector.vite()` **before** `react()`, `vue()`, `svelte()`, or `preact()`. Otherwise source locations may show `unknown:0:0`.
137+
> ⚠️ **Plugin order matters:** Place `DevInspector.vite()` **before** `react()`, `vue()`, `svelte()`, `solid()`, or `preact()`. Otherwise source locations may show `unknown:0:0`.
111138
112139
#### For Non-HTML Projects (Miniapps, Library Bundles)
113140

@@ -201,6 +228,22 @@ export default function RootLayout({ children }) {
201228

202229
> 💡 **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).
203230
231+
## Framework Support
232+
233+
### ✅ Fully Supported
234+
235+
- **React** - `.jsx` and `.tsx` files (Vite, Webpack, Next.js)
236+
- **Vue** - `.vue` single-file components (Vite, Webpack)
237+
- **Svelte** - `.svelte` components (Vite, Webpack)
238+
- **SolidJS** - `.jsx` and `.tsx` files (Vite, Webpack)
239+
- **Preact** - `.jsx` and `.tsx` files (Vite, Webpack)
240+
- **Next.js** - React with Webpack mode
241+
242+
### 🚧 In Progress
243+
244+
- **Angular** - Support coming soon
245+
246+
204247

205248
## Configuration
206249

packages/unplugin-dev-inspector/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@mcpc-tech/unplugin-dev-inspector-mcp",
3-
"version": "0.0.19",
3+
"version": "0.0.20",
44
"description": "Universal dev inspector plugin for React/Vue - inspect component sources and API calls in any bundler",
55
"type": "module",
66
"license": "MIT",

0 commit comments

Comments
 (0)