beeperbox 0.8.0 → 0.8.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 +43 -10
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,18 +1,28 @@
|
|
|
1
|
-
|
|
1
|
+
```
|
|
2
|
+
╭──────────────────────────────────╮
|
|
3
|
+
│ ╔╗ ╔═╗╔═╗╔═╗╔═╗╦═╗╔╗ ╔═╗ ╦ ╦ │
|
|
4
|
+
│ ╠╩╗╠╣ ╠╣ ╠═╝╠╣ ╠╦╝╠╩╗║ ║ ╚╦╝ │
|
|
5
|
+
│ ╚═╝╚═╝╚═╝╩ ╚═╝╩╚═╚═╝╚═╝ ╩ ╩ │
|
|
6
|
+
│ one agent ──→ 50+ messengers │
|
|
7
|
+
╰──────────────────────────────────╯
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
<p align="center">
|
|
11
|
+
<a href="https://www.npmjs.com/package/beeperbox"><img src="https://img.shields.io/npm/v/beeperbox?label=npm&color=2a4f8c" alt="npm version"></a>
|
|
12
|
+
<a href="https://github.com/hamr0/beeperbox"><img src="https://img.shields.io/badge/source-github-2a4f8c" alt="source on GitHub"></a>
|
|
13
|
+
<img src="https://img.shields.io/badge/license-Apache%202.0-2a4f8c" alt="license: Apache 2.0">
|
|
14
|
+
</p>
|
|
2
15
|
|
|
3
16
|
**Run beeperbox's MCP verb server against a Beeper Desktop you already have open — no Docker, no Electron, no Xvfb.**
|
|
4
17
|
|
|
5
18
|
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
19
|
|
|
7
|
-
- **Always-on / VPS / no local Beeper?** Use the [Docker image](https://github.com/hamr0/beeperbox#quick-start).
|
|
20
|
+
- **Always-on / VPS / no local Beeper?** Use the [Docker image](https://github.com/hamr0/beeperbox#quick-start-container).
|
|
8
21
|
- **Beeper already open on your machine?** Use this.
|
|
9
22
|
|
|
10
|
-
##
|
|
23
|
+
## Quick start
|
|
11
24
|
|
|
12
|
-
|
|
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
|
|
25
|
+
**Prereqs:** Beeper Desktop running locally, with the Developer API enabled — Beeper → **Settings → Developers** → enable the API and create an access token (the same token the container uses).
|
|
16
26
|
|
|
17
27
|
```sh
|
|
18
28
|
BEEPER_TOKEN=your-token-here npx beeperbox
|
|
@@ -20,12 +30,22 @@ BEEPER_TOKEN=your-token-here npx beeperbox
|
|
|
20
30
|
|
|
21
31
|
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
32
|
|
|
23
|
-
For stdio transport (Claude Code, Cursor, Cline, Continue, bareagent):
|
|
33
|
+
For stdio transport (Claude Code, Cursor, Cline, Continue, [bareagent](https://npmjs.com/package/bare-agent)):
|
|
24
34
|
|
|
25
35
|
```sh
|
|
26
36
|
BEEPER_TOKEN=your-token-here npx beeperbox --stdio
|
|
27
37
|
```
|
|
28
38
|
|
|
39
|
+
## The 12 tools
|
|
40
|
+
|
|
41
|
+
One opinionated MCP verb layer over Beeper — every tool returns a normalized `Chat` / `Message` schema, propagates `chat_id` + `network` onto every message, and is documented in-schema for the model. Reach across all 50+ networks without knowing which bridge you're talking to.
|
|
42
|
+
|
|
43
|
+
- **Read / triage** — `list_accounts` · `list_inbox` · `list_unread` · `get_chat` · `read_chat` · `search_messages`
|
|
44
|
+
- **Write / act** — `send_message` · `note_to_self` · `react_to_message` · `archive_chat`
|
|
45
|
+
- **Watch / reach** — `poll_messages` (read-only watch primitive, restart-safe cursor, `source` echo-guard) · `download_asset` (attachment bytes; every message carries `attachments[]`)
|
|
46
|
+
|
|
47
|
+
Full schemas and usage in the [main README](https://github.com/hamr0/beeperbox#the-mcp).
|
|
48
|
+
|
|
29
49
|
## Config
|
|
30
50
|
|
|
31
51
|
| Env | Meaning | Default |
|
|
@@ -45,6 +65,19 @@ The server binds **loopback only** (`127.0.0.1`) by default, so it's safe with n
|
|
|
45
65
|
|
|
46
66
|
There's no Docker restart policy in lite mode. For an always-on setup, run it under `systemd` or `pm2`.
|
|
47
67
|
|
|
48
|
-
See the [full README](https://github.com/hamr0/beeperbox#
|
|
68
|
+
See the [full README](https://github.com/hamr0/beeperbox#the-mcp) and [docs/GUIDE.md](https://github.com/hamr0/beeperbox/blob/master/docs/GUIDE.md) for the complete tool reference and the container build.
|
|
69
|
+
|
|
70
|
+
## The bare ecosystem
|
|
71
|
+
|
|
72
|
+
Local-first, composable agent infrastructure. Same API patterns throughout — mix and match, each module works standalone.
|
|
73
|
+
|
|
74
|
+
- **[bareagent](https://npmjs.com/package/bare-agent)** — the think→act→observe loop. *Goal in → coordinated actions out.*
|
|
75
|
+
- **[bareguard](https://npmjs.com/package/bareguard)** — the single gate every action passes through. *Action in → allow / deny / ask-a-human out.*
|
|
76
|
+
- **[litectx](https://npmjs.com/package/litectx)** — code + memory graph with activation decay. *Query in → ranked context out.*
|
|
77
|
+
- **[barebrowse](https://npmjs.com/package/barebrowse)** — a real browser for agents. *URL in → pruned snapshot out.*
|
|
78
|
+
- **[baremobile](https://npmjs.com/package/baremobile)** — Android + iOS device control. *Screen in → pruned snapshot out.*
|
|
79
|
+
- **beeperbox** *(this)* — 50+ messaging networks via one MCP server. *Chat in → unified message stream out.*
|
|
80
|
+
|
|
81
|
+
## License
|
|
49
82
|
|
|
50
|
-
[Apache-2.0](https://github.com/hamr0/beeperbox/blob/master/LICENSE)
|
|
83
|
+
[Apache-2.0](https://github.com/hamr0/beeperbox/blob/master/LICENSE). Independent wrapper around Beeper Desktop, no affiliation with Beeper / Automattic.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "beeperbox",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.1",
|
|
4
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
5
|
"bin": {
|
|
6
6
|
"beeperbox": "server.js"
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"url": "git+https://github.com/hamr0/beeperbox.git",
|
|
35
35
|
"directory": "mcp"
|
|
36
36
|
},
|
|
37
|
-
"homepage": "https://github.com/hamr0/beeperbox#lite-mode",
|
|
37
|
+
"homepage": "https://github.com/hamr0/beeperbox#lite-mode-npx",
|
|
38
38
|
"bugs": "https://github.com/hamr0/beeperbox/issues",
|
|
39
39
|
"author": "hamr0",
|
|
40
40
|
"license": "Apache-2.0"
|