proofboard-mcp 0.0.0-stage → 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 +51 -2
- package/dist/proofboard-mcp.mjs +164 -0
- package/package.json +10 -4
package/README.md
CHANGED
|
@@ -1,3 +1,52 @@
|
|
|
1
|
-
#
|
|
1
|
+
# proofboard-mcp
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
MCP server for **[Proofboard](https://nemalsomel.github.io/proofboard/)** – a perfboard / stripboard circuit designer and simulator.
|
|
4
|
+
It lets Claude (Claude Desktop, Claude Code or any MCP client) place parts, connect pins (wiring is routed automatically),
|
|
5
|
+
compact the layout, simulate, check problems and generate firmware code.
|
|
6
|
+
|
|
7
|
+
- **Live in the browser:** open Proofboard and choose *File › Claude connection… › Connect*. Claude's changes then appear
|
|
8
|
+
live on your board; a bar shows while Claude is working (manual editing pauses), and each working session is one undo step.
|
|
9
|
+
A *read only* switch lets Claude look and check without changing anything.
|
|
10
|
+
- **Headless:** without the app, the server works on an in-memory design that Claude can save to a file
|
|
11
|
+
(`save_design_file`) and you can open in the app (*File › Open*).
|
|
12
|
+
|
|
13
|
+
Claude uses your own Claude subscription – no API key is needed.
|
|
14
|
+
|
|
15
|
+
## Setup
|
|
16
|
+
|
|
17
|
+
Requires Node.js 18+.
|
|
18
|
+
|
|
19
|
+
**Claude Desktop** – Settings › Developer › Edit Config (`claude_desktop_config.json`), then restart Claude:
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
{ "mcpServers": { "proofboard": { "command": "npx", "args": ["-y", "proofboard-mcp"] } } }
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Claude Code:**
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
claude mcp add proofboard -- npx -y proofboard-mcp
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Then open https://nemalsomel.github.io/proofboard/ › *File › Claude connection…* › *Connect*, and ask Claude e.g.
|
|
32
|
+
“Design a LED blinker on the Pico, then check that it is compact.”
|
|
33
|
+
|
|
34
|
+
## Options
|
|
35
|
+
|
|
36
|
+
| Option | |
|
|
37
|
+
|---|---|
|
|
38
|
+
| `--port N` (or `PROOFBOARD_PORT`) | bridge port (default 47615; set the same port in the app under *Advanced*) |
|
|
39
|
+
| `--no-bridge` | headless only |
|
|
40
|
+
| `--allow-origin URL` | also accept the app from another origin (self-hosted copy) |
|
|
41
|
+
|
|
42
|
+
## Security
|
|
43
|
+
|
|
44
|
+
The bridge listens on `127.0.0.1` only and accepts browser connections only from the Proofboard site (and localhost).
|
|
45
|
+
The app connects only when you press *Connect* (or enable auto-connect), and you can disconnect at any time.
|
|
46
|
+
|
|
47
|
+
## Tools
|
|
48
|
+
|
|
49
|
+
`bridge_status`, `open_design_file`, `save_design_file`, and the Proofboard design tools: `get_design`, `list_part_types`,
|
|
50
|
+
`describe_part_type`, `get_part`, `place_part`, `move_part`, `set_params`, `remove_parts`, `connect`, `disconnect`, `route`,
|
|
51
|
+
`get_problems`, `simulate`, `set_gpio_mode`, `add_note`, `generate_code`, `get_board_image` (live only), `set_project_notes`,
|
|
52
|
+
`plan_compaction`, `compact_layout`, `set_fixed`, `list_examples` / `load_example` (live only), `new_design`.
|