@explainui/mcp 0.1.0-beta.1 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -29,9 +29,64 @@ Add to your `claude_desktop_config.json`:
29
29
  }
30
30
  ```
31
31
 
32
- ### Cursor / Windsurf / Cline
32
+ ### Cursor
33
33
 
34
- Consult your editor's MCP configuration docs and add `explainui-mcp` as a stdio server with the environment variable below.
34
+ Add to `.cursor/mcp.json` in your project root:
35
+
36
+ ```json
37
+ {
38
+ "mcpServers": {
39
+ "explainui": {
40
+ "command": "explainui-mcp",
41
+ "env": {
42
+ "EXPLAINUI_LICENSE_KEY": "ek_live_your_key_here"
43
+ }
44
+ }
45
+ }
46
+ }
47
+ ```
48
+
49
+ ### GitHub Copilot (VS Code)
50
+
51
+ Add to your VS Code `settings.json` or `.vscode/mcp.json`:
52
+
53
+ ```json
54
+ {
55
+ "mcp": {
56
+ "servers": {
57
+ "explainui": {
58
+ "command": "explainui-mcp",
59
+ "env": {
60
+ "EXPLAINUI_LICENSE_KEY": "ek_live_your_key_here"
61
+ }
62
+ }
63
+ }
64
+ }
65
+ }
66
+ ```
67
+
68
+ Then in Copilot Chat, use agent mode (`@workspace`) and mention your ExplainUI project ID — Copilot will discover and call the MCP tools automatically.
69
+
70
+ ### Windsurf
71
+
72
+ Add to your Windsurf MCP config (`~/.codeium/windsurf/mcp_config.json`):
73
+
74
+ ```json
75
+ {
76
+ "mcpServers": {
77
+ "explainui": {
78
+ "command": "explainui-mcp",
79
+ "env": {
80
+ "EXPLAINUI_LICENSE_KEY": "ek_live_your_key_here"
81
+ }
82
+ }
83
+ }
84
+ }
85
+ ```
86
+
87
+ ### Cline
88
+
89
+ Open the Cline MCP settings panel in VS Code and add a new server with command `explainui-mcp` and the environment variable below.
35
90
 
36
91
  ## Environment Variables
37
92
 
@@ -61,7 +116,7 @@ Run a UX QA check. Captures screenshots at 3 viewports (desktop 1280×800, table
61
116
  | `project_id` | string | Yes | Project ID from attach step |
62
117
  | `page_key` | string | Yes | Page to check (e.g. `homepage`, `pricing`) |
63
118
  | `iteration` | integer | Yes | Iteration count (1–10), increment after each call |
64
- | `this_iteration` | string | Yes | What was built/changed (40–500 chars) |
119
+ | `this_iteration` | string | Yes | What was built/changed (40–2000 chars) |
65
120
  | `git_snapshot_hash` | string | No | Short SHA from pre-analysis commit |
66
121
 
67
122
  **Returns:** Pass/fail verdict, per-check results, issues with severity and fix suggestions.
package/dist/capture.d.ts CHANGED
@@ -11,6 +11,7 @@
11
11
  import { type CaptureResult } from "./types.js";
12
12
  /**
13
13
  * Capture screenshots at all configured viewports for a given URL.
14
+ * Also runs deterministic DOM checks and extracts element maps.
14
15
  * Returns base64-encoded JPEG screenshots with labels.
15
16
  */
16
17
  export declare function captureAllViewports(url: string): Promise<CaptureResult>;
@@ -1 +1 @@
1
- {"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../src/capture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAA8B,KAAK,aAAa,EAAkB,MAAM,YAAY,CAAC;AAmB5F;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAmF7E;AAED;;GAEG;AACH,wBAAsB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAKlD"}
1
+ {"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../src/capture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH,OAAO,EAGL,KAAK,aAAa,EAYnB,MAAM,YAAY,CAAC;AAo6DpB;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAsK7E;AAED;;GAEG;AACH,wBAAsB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAKlD"}