ghostrun-cli 1.0.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Sharan Iyengar
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/MCP-SETUP.md ADDED
@@ -0,0 +1,82 @@
1
+ # GhostRun MCP Server
2
+
3
+ GhostRun exposes a standard [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server. Any MCP-compatible AI client can connect to it — not just Claude Desktop.
4
+
5
+ **Works with:** Claude Desktop · Cursor · Windsurf · OpenClaw · Zed · any MCP client
6
+
7
+ ## Quick Start
8
+
9
+ ```bash
10
+ # Compiled version (recommended)
11
+ node mcp-server.js
12
+
13
+ # TypeScript source (dev)
14
+ npx tsx mcp-server.ts
15
+ ```
16
+
17
+ ## Available Tools
18
+
19
+ | Tool | Description |
20
+ |------|-------------|
21
+ | `list_flows` | List all saved flows with pass rates |
22
+ | `get_flow` | Get flow details and step graph |
23
+ | `run_flow` | Execute a flow with Playwright (headless) |
24
+ | `get_run_result` | Detailed per-step results with screenshots |
25
+ | `list_runs` | Recent run history |
26
+ | `delete_flow` | Remove a flow |
27
+ | `get_status` | Statistics, AI provider, creator breakdown |
28
+
29
+ ## Claude Desktop
30
+
31
+ Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
32
+
33
+ ```json
34
+ {
35
+ "mcpServers": {
36
+ "ghostrun": {
37
+ "command": "node",
38
+ "args": ["/ABSOLUTE/PATH/TO/ghostrun/mcp-server.js"],
39
+ "env": {
40
+ "ANTHROPIC_API_KEY": "optional — enables AI failure analysis"
41
+ }
42
+ }
43
+ }
44
+ }
45
+ ```
46
+
47
+ Restart Claude Desktop. Ask it:
48
+ - *"List my GhostRun flows"*
49
+ - *"Run the login flow and tell me if it passed"*
50
+ - *"What failed in the last checkout run?"*
51
+
52
+ ## Cursor / Windsurf / Other MCP Clients
53
+
54
+ Point your MCP client at the server process:
55
+
56
+ ```
57
+ command: node
58
+ args: ["/absolute/path/to/ghostrun/mcp-server.js"]
59
+ ```
60
+
61
+ Refer to your client's MCP documentation for the exact config format.
62
+
63
+ ## Programmatic (stdio transport)
64
+
65
+ ```typescript
66
+ import { Client } from "@modelcontextprotocol/sdk/client/index.js";
67
+ import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
68
+
69
+ const transport = new StdioClientTransport({
70
+ command: "node",
71
+ args: ["/path/to/mcp-server.js"],
72
+ });
73
+ const client = new Client({ name: "my-app", version: "1.0" }, { capabilities: {} });
74
+ await client.connect(transport);
75
+
76
+ // List flows
77
+ const result = await client.callTool({ name: "list_flows", arguments: {} });
78
+ ```
79
+
80
+ ## AI Analysis
81
+
82
+ Set `ANTHROPIC_API_KEY` (or run Ollama locally) to enable plain-English failure summaries. When a flow fails, GhostRun explains what broke and how to fix it.