You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Summary
- **README install section** expanded to cover every major MCP client:
Claude Code, Claude Desktop, Gemini CLI, GitHub Copilot (VS Code),
Cursor, Cline, Windsurf, Continue.dev, Zed, plus a generic stdio
template.
- **Runtime docs corrected** — clone-and-configure path lists Deno
(preferred per CLAUDE.md policy), Bun, and Node as valid runtimes.
Dropped the spurious `npm install` step (zero-dep package).
- **Version bump** 0.4.6 → 0.4.7 in `package.json`,
`gemini-extension.json`, `jsr.json`, `stapeln.toml`.
## Why this release matters for Glama
The AAA-tier tool-description rewrite landed in `25887157` / `ad837abe`
after **0.4.1**, but was never `npm publish`'d. Glama runs the npm
package, so it scored the v0.4.1 stub descriptions ("Check BoJ server
health status") and graded Quality C.
Publishing 0.4.7 ships the rich Purpose / Behavior / Returns / Errors /
Usage text and per-parameter `description` fields with patterns/enums.
After Glama's next scan, Quality should land A.
## Test plan
- [ ] CI green (dogfood-gate, hypatia-scan, codeql, etc.)
- [ ] Tag `v0.4.7` after merge → triggers
`.github/workflows/publish.yml` (npm + JSR)
- [ ] Verify `npm view @hyperpolymath/boj-server@latest version` returns
`0.4.7`
- [ ] Trigger Glama re-scan via dashboard
- [ ] Confirm Quality grade moves C → A on Glama
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+175-6Lines changed: 175 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,21 +8,190 @@ BoJ (Bundle of Joy) is a unified MCP server that consolidates all hyperpolymath
8
8
9
9
## Install
10
10
11
-
Add to Claude Code:
11
+
BoJ ships as an MCP server over stdio. Every snippet below uses the published npm package; replace `npx -y @hyperpolymath/boj-server@latest` with one of the following from a local clone:
12
+
13
+
```bash
14
+
# Preferred — Deno (no install step; fetches imports on first run)
15
+
deno run -A /path/to/boj-server/mcp-bridge/main.js
16
+
17
+
# Bun (also zero-install)
18
+
bun /path/to/boj-server/mcp-bridge/main.js
19
+
20
+
# Node — works, but Deno is the project's documented runtime
21
+
node /path/to/boj-server/mcp-bridge/main.js
22
+
```
23
+
24
+
The bridge has **zero runtime dependencies** (see `package.json`) so no install step is ever required, regardless of runtime.
25
+
26
+
Most cartridges require the BoJ REST backend running on `http://localhost:7700` — see [Backend](#backend) below.
27
+
28
+
### Claude Code (CLI)
12
29
13
30
```bash
14
31
claude mcp add boj-server -- npx -y @hyperpolymath/boj-server@latest
The minimum spec is `command: npx`, `args: ["-y", "@hyperpolymath/boj-server@latest"]`, transport `stdio`. Optional env: `BOJ_URL` (default `http://localhost:7700`).
181
+
182
+
This repo's `.mcp.json` is a working reference config.
183
+
184
+
### Backend
185
+
186
+
Most cartridges (GitHub/GitLab/Cloud/ML/Browser/CodeSeeker/etc.) call the BoJ REST API. Two options:
187
+
188
+
1. **Run BoJ locally** — clone this repo and `just run` (see [QUICKSTART-USER.adoc](./QUICKSTART-USER.adoc)). REST API on port 7700.
189
+
2. **Inspectable mode only** — without the backend, `boj_health`, `boj_menu`, `boj_cartridges`, and `boj_cartridge_info` still respond from the offline manifest fallback, so MCP clients can introspect the server without running anything else. Side-effectful tools will return `{error, hint}` until the backend is up.
190
+
191
+
### Verify
192
+
193
+
After install, ask the LLM: *"Use the `boj_health` tool."* You should get `{status: "ok", uptime_s, version}` when the backend is up, or a structured hint when it's offline.
0 commit comments