@maslowcnc/abundance-bridge 0.1.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 +674 -0
- package/README.md +60 -0
- package/dist/index.js +1262 -0
- package/package.json +42 -0
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Abundance AI agent bridge
|
|
2
|
+
|
|
3
|
+
Lets an AI agent on your computer, such as Claude, inspect and edit the [Abundance](https://abundance.maslowcnc.com) CAD project open in your browser. It's an MCP server: your AI app starts it, and your Abundance tab connects to it over a local, token-protected connection.
|
|
4
|
+
|
|
5
|
+
You need [Node.js](https://nodejs.org) 18 or newer.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
Claude Code:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
claude mcp add --scope user abundance -- npx -y @maslowcnc/abundance-bridge@latest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Other MCP clients (Claude Desktop, Cursor, VS Code, ...) take the same command in their MCP server settings:
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"mcpServers": {
|
|
20
|
+
"abundance": {
|
|
21
|
+
"command": "npx",
|
|
22
|
+
"args": ["-y", "@maslowcnc/abundance-bridge@latest"]
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
`@latest` keeps the bridge in step with the Abundance website, which updates continuously.
|
|
29
|
+
|
|
30
|
+
## Connect your project
|
|
31
|
+
|
|
32
|
+
1. Ask your AI app for the Abundance pairing token. It calls the `bridge_status` tool and shows you the token and port.
|
|
33
|
+
2. Open Abundance in Chrome or Firefox and open **Connect an AI agent**: the sparkle button on the right in run mode, **AI Agent** in the editor's menu, or add `#agent` to the end of the page address.
|
|
34
|
+
3. Paste the token, check the port, and turn on **Connect local AI agent**.
|
|
35
|
+
|
|
36
|
+
The agent starts read-only. Tick **Allow edits** in the chip at the top of the window to let it change the project. Edit permission resets whenever the page reloads.
|
|
37
|
+
|
|
38
|
+
## Options
|
|
39
|
+
|
|
40
|
+
| Flag | Default | |
|
|
41
|
+
|---|---|---|
|
|
42
|
+
| `--port <n>` | `4455` | Port the browser tab connects to. Also `ABUNDANCE_BRIDGE_PORT`. |
|
|
43
|
+
| `--out-dir <folder>` | `~/Documents/Abundance Exports` | Where exported STL, STEP, SVG and G-code files go. |
|
|
44
|
+
| `--print-token` | | Print the pairing token and exit. |
|
|
45
|
+
| `--new-token` | | Replace the pairing token. Paired tabs must paste the new one. |
|
|
46
|
+
| `--origin <url>` | | Also accept tabs from this site (for self-hosted Abundance). |
|
|
47
|
+
|
|
48
|
+
The pairing token is stored in `~/.abundance-bridge/token`.
|
|
49
|
+
|
|
50
|
+
## Security
|
|
51
|
+
|
|
52
|
+
The bridge only listens on `127.0.0.1`, only accepts tabs from the Abundance website or a local dev server, and only after they present the pairing token. The website never accepts incoming connections: your tab connects out to the bridge.
|
|
53
|
+
|
|
54
|
+
## Source
|
|
55
|
+
|
|
56
|
+
Built from [`bridge/`](https://github.com/BarbourSmith/Abundance/tree/main/bridge) in the Abundance repository. Full tool list and design notes are in its README.
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
GPL-3.0-or-later. See [LICENSE](LICENSE).
|