busybar-mcp 0.0.0-stage → 0.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 viirtualp1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,94 @@
-# Temporary Holding Version
+# busybar-mcp
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> [!IMPORTANT]
+> Unofficial community project, not affiliated with Flipper Devices / BUSY.
+
+Let Claude and Codex draw and play sounds on your [BUSY Bar](https://busy.app/): text, pixel art, pictures,
+animations, melodies, GitHub status and the weather.
+
+Just ask: *"put 'In a meeting' on the Bar"*, *"draw a cat on the back screen"*, *"play a fanfare"*.
+
+## Install
+
+**Claude Code:** type this in Claude Code.
+
+```
+/plugin install busybar --marketplace viirtualp1/busybar-mcp
+```
+
+**Claude Desktop:** download [`busybar.mcpb`](https://github.com/viirtualp1/busybar-mcp/releases/latest),
+double-click it, press **Install**.
+
+**Codex:**
+
+```bash
+npx busybar-mcp install
+```
+
+The Bar is found over USB. On Wi-Fi, tell Claude where it is: *"my Bar is at 192.168.1.50"*.
+
+> On macOS, allow the app under **System Settings → Privacy & Security → Local Network**,
+> or it won't reach the Bar.
+
+## Updating
+
+When a new version is out, Claude or Codex tells you in the next conversation, with what to run:
+
+- **Claude Code:** `/plugin update busybar`
+- **Claude Desktop:** download the new `busybar.mcpb` and double-click it
+- **Codex:** `npx busybar-mcp@latest update`
+
+What changed is in the [changelog](./CHANGELOG.md). To hear about releases on GitHub: **Watch → Custom → Releases**.
+
+## What it can do
+
+| Tool | |
+| --- | --- |
+| `bar_text` | one or two lines of text |
+| `bar_pixels` | pixel art |
+| `bar_progress` | a progress bar |
+| `bar_image` | a picture from a file, a URL or the Bar's stock |
+| `bar_animation` | a built-in animation |
+| `bar_sound` | a built-in sound, an audio file, or a melody |
+| `bar_stock` | list built-in images, animations and sounds |
+| `bar_screenshot` | see what the screen shows |
+| `bar_clear` | give the screen back to the Bar |
+| `bar_connect` | tell it where your Bar is |
+| `bar_status` | is the Bar reachable |
+| `github_ci` | latest CI run of a repo |
+| `github_inbox` | PRs to review, your PRs, your issues |
+| `weather` | weather for a city |
+
+Works on both screens: the front colour strip and the back greyscale panel.
+
+**Answer-ready notifications.** When Claude Code or Codex finishes an answer, the Bar shows its logo and a short
+summary of the answer, blinks and chimes; Claude Code also shows when it is waiting for your permission. Turn it off in `/plugin` settings
+(Claude Code) or with `npx busybar-mcp install --no-notify` (Codex).
+
+## Settings
+
+Set in the plugin's settings (Claude Code), the extension's (Claude Desktop), or by `bar_connect` and
+`npx busybar-mcp install` in `~/.busybar-mcp/config.json`. Environment variables override them.
+
+| Key | |
+| --- | --- |
+| `BUSY_ADDR` | Bar address, default `10.0.4.20` (USB) |
+| `BUSY_HTTP_PASSWORD` | if the Bar's HTTP access is locked |
+| `BUSY_TOKEN` | cloud token, with `BUSY_ADDR=https://api.busy.app` |
+| `GITHUB_TOKEN` | otherwise `gh auth token` is used |
+
+## Development
+
+```bash
+npm install
+npm run build                     # build/server.mjs, build/busybar.mcpb, plugin/
+BUSYBAR_DRY_RUN=1 npm run smoke   # every tool, no Bar needed
+npm run live                      # media tools on a real Bar
+```
+
+To release: bump `version`, add a `## X.Y.Z` section to `CHANGELOG.md`, `npm run build`, commit, tag `vX.Y.Z` and push.
+CI publishes to npm and makes a GitHub release with `busybar.mcpb` and that changelog section.
+
+## License
+
+[MIT](./LICENSE)