livetap 0.1.2 → 0.1.3
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 +35 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,32 +28,56 @@ Then ask your agent:
|
|
|
28
28
|
|
|
29
29
|
## Setup with Claude Code (for AI agents)
|
|
30
30
|
|
|
31
|
-
If you are Claude Code or another AI agent and a user asks you to install and use livetap, follow these steps exactly
|
|
31
|
+
If you are Claude Code or another AI agent and a user asks you to install and use livetap, follow these steps **exactly**. Do NOT improvise — livetap uses stdio MCP (not HTTP), and requires Bun (not npm/node).
|
|
32
32
|
|
|
33
|
-
### Step 1: Install
|
|
33
|
+
### Step 1: Install with Bun (NOT npm)
|
|
34
34
|
|
|
35
35
|
```bash
|
|
36
|
-
bun
|
|
37
|
-
bun
|
|
36
|
+
bun init -y # if no package.json exists
|
|
37
|
+
bun add livetap # MUST use bun, not npm — postinstall needs bun
|
|
38
|
+
bun pm trust livetap # required — bun blocks untrusted postinstall scripts
|
|
38
39
|
```
|
|
39
40
|
|
|
40
|
-
|
|
41
|
+
### Step 2: Verify .mcp.json was created
|
|
42
|
+
|
|
43
|
+
The postinstall creates `.mcp.json` in the project root. Check it:
|
|
41
44
|
|
|
42
45
|
```bash
|
|
43
46
|
cat .mcp.json
|
|
44
47
|
```
|
|
45
48
|
|
|
46
|
-
It should
|
|
49
|
+
It should look like this (path will vary):
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"mcpServers": {
|
|
53
|
+
"livetap": {
|
|
54
|
+
"command": "bun",
|
|
55
|
+
"args": ["/path/to/node_modules/livetap/src/mcp/channel.ts"]
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**IMPORTANT:** livetap is a **stdio MCP server** (command + args), NOT an HTTP MCP server. Do NOT add it to `~/.claude/mcp.json` as `"type": "http"`. The `.mcp.json` in the project root is correct.
|
|
47
62
|
|
|
48
|
-
|
|
63
|
+
If `.mcp.json` was not created, create it manually:
|
|
64
|
+
```bash
|
|
65
|
+
echo '{"mcpServers":{"livetap":{"command":"bun","args":["'$(pwd)'/node_modules/livetap/src/mcp/channel.ts"]}}}' > .mcp.json
|
|
66
|
+
```
|
|
49
67
|
|
|
50
|
-
|
|
68
|
+
### Step 3: Tell the user to restart Claude Code
|
|
51
69
|
|
|
52
|
-
|
|
53
|
-
|
|
70
|
+
You CANNOT restart yourself. Tell the user exactly this:
|
|
71
|
+
|
|
72
|
+
> "livetap is installed and configured. Please restart Claude Code with:
|
|
73
|
+
> ```
|
|
74
|
+
> claude --dangerously-load-development-channels server:livetap
|
|
75
|
+
> ```
|
|
54
76
|
> Then ask me to connect to your data source."
|
|
55
77
|
|
|
56
|
-
|
|
78
|
+
Do NOT try to start the daemon yourself — the MCP proxy auto-starts it when Claude Code restarts.
|
|
79
|
+
|
|
80
|
+
### Step 4: After restart — use MCP tools
|
|
57
81
|
|
|
58
82
|
Once restarted with the channel flag, you have 12 MCP tools available. Follow this workflow:
|
|
59
83
|
|