beeperbox 0.7.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/README.md +49 -0
- package/package.json +41 -0
- package/server.js +1306 -0
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# beeperbox (lite mode)
|
|
2
|
+
|
|
3
|
+
**Run beeperbox's MCP verb server against a Beeper Desktop you already have open — no Docker, no Electron, no Xvfb.**
|
|
4
|
+
|
|
5
|
+
This is the *lite* half of [beeperbox](https://github.com/hamr0/beeperbox). The full project ships a Docker image with a headless Beeper Desktop inside; lite mode is the same single-file, zero-dependency MCP server pointed at a Beeper Desktop **you** run on your laptop. Identical verb surface, identical version — you just supply Beeper.
|
|
6
|
+
|
|
7
|
+
- **Always-on / VPS / no local Beeper?** Use the [Docker image](https://github.com/hamr0/beeperbox#quick-start).
|
|
8
|
+
- **Beeper already open on your machine?** Use this.
|
|
9
|
+
|
|
10
|
+
## Prerequisites
|
|
11
|
+
|
|
12
|
+
1. **Beeper Desktop** running locally.
|
|
13
|
+
2. **Developer API enabled:** Beeper → **Settings → Developers** → enable the API and create an access token (the same token the container uses).
|
|
14
|
+
|
|
15
|
+
## Run
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
BEEPER_TOKEN=your-token-here npx beeperbox
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
That starts the MCP HTTP server on `http://127.0.0.1:23375`, pointed at the local Beeper Desktop API on `http://127.0.0.1:23373`. On boot it logs a one-line reachability verdict (`preflight OK: … N account(s)` or `preflight FAIL: …`) so a misconfigured token or API is obvious immediately.
|
|
22
|
+
|
|
23
|
+
For stdio transport (Claude Code, Cursor, Cline, Continue, bareagent):
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
BEEPER_TOKEN=your-token-here npx beeperbox --stdio
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Config
|
|
30
|
+
|
|
31
|
+
| Env | Meaning | Default |
|
|
32
|
+
|---|---|---|
|
|
33
|
+
| `BEEPER_API` | Local Beeper Desktop API base | `http://127.0.0.1:23373` |
|
|
34
|
+
| `BEEPER_TOKEN` | Beeper dev token (Settings → Developers) | — (required) |
|
|
35
|
+
| `MCP_PORT` | MCP HTTP port | `23375` |
|
|
36
|
+
| `MCP_AUTH_TOKEN` | Optional bearer guard on the MCP endpoint | unset (open on loopback) |
|
|
37
|
+
| `MCP_ALLOWED_HOSTS` | Host/Origin allowlist | `localhost,127.0.0.1,::1` |
|
|
38
|
+
|
|
39
|
+
## Security
|
|
40
|
+
|
|
41
|
+
The server binds `0.0.0.0` but is meant to stay loopback-only: it's safe on `127.0.0.1` with no auth. To expose it beyond your machine, set `MCP_AUTH_TOKEN` **and** `MCP_ALLOWED_HOSTS`, and put it behind a tunnel (SSH / Tailscale / TLS reverse proxy) — never raw on a public interface.
|
|
42
|
+
|
|
43
|
+
## Supervision
|
|
44
|
+
|
|
45
|
+
There's no Docker restart policy in lite mode. For an always-on setup, run it under `systemd` or `pm2`.
|
|
46
|
+
|
|
47
|
+
See the [full README](https://github.com/hamr0/beeperbox#lite-mode) and [docs/GUIDE.md](https://github.com/hamr0/beeperbox/blob/master/docs/GUIDE.md) for the complete tool reference and the container build.
|
|
48
|
+
|
|
49
|
+
[Apache-2.0](https://github.com/hamr0/beeperbox/blob/master/LICENSE)
|
package/package.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "beeperbox",
|
|
3
|
+
"version": "0.7.0",
|
|
4
|
+
"description": "Lite mode for beeperbox — the opinionated MCP verb server for Beeper Desktop, run standalone against a Beeper you already have open (no Docker, no Electron). The full headless-Beeper-in-Docker build lives at github.com/hamr0/beeperbox.",
|
|
5
|
+
"bin": {
|
|
6
|
+
"beeperbox": "server.js"
|
|
7
|
+
},
|
|
8
|
+
"main": "server.js",
|
|
9
|
+
"type": "commonjs",
|
|
10
|
+
"files": [
|
|
11
|
+
"server.js",
|
|
12
|
+
"README.md"
|
|
13
|
+
],
|
|
14
|
+
"engines": {
|
|
15
|
+
"node": ">=18"
|
|
16
|
+
},
|
|
17
|
+
"scripts": {
|
|
18
|
+
"start": "node server.js",
|
|
19
|
+
"test": "node --test server.test.js"
|
|
20
|
+
},
|
|
21
|
+
"keywords": [
|
|
22
|
+
"mcp",
|
|
23
|
+
"model-context-protocol",
|
|
24
|
+
"beeper",
|
|
25
|
+
"messaging",
|
|
26
|
+
"whatsapp",
|
|
27
|
+
"imessage",
|
|
28
|
+
"telegram",
|
|
29
|
+
"signal",
|
|
30
|
+
"agent"
|
|
31
|
+
],
|
|
32
|
+
"repository": {
|
|
33
|
+
"type": "git",
|
|
34
|
+
"url": "git+https://github.com/hamr0/beeperbox.git",
|
|
35
|
+
"directory": "mcp"
|
|
36
|
+
},
|
|
37
|
+
"homepage": "https://github.com/hamr0/beeperbox#lite-mode",
|
|
38
|
+
"bugs": "https://github.com/hamr0/beeperbox/issues",
|
|
39
|
+
"author": "hamr0",
|
|
40
|
+
"license": "Apache-2.0"
|
|
41
|
+
}
|