Skip to content

Commit 03c462b

Browse files
docs: README — add --mcp flag, --bundle install, bundles table, Run agents section
Catches the README up to what jspod has shipped lately: - --mcp flag (passthrough to JSS, the MCP server capstone in JSS 0.0.200+) - --bundle install pattern (apt-style meta-packages, from JSS#464 phase 6) - Available bundles table (starter / all / media / productivity / agentic) - 'Run agents' section pointing at charlie + the agentic bundle
1 parent 2ed7bed commit 03c462b

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ That's it. You have a working Solid pod with a passkey-capable identity provider
3333
--no-git Disable JSS's git HTTP backend
3434
--browser <style> Data browser: folder (default) or json
3535
--provision-keys Generate a Nostr-compatible owner keypair on first start
36+
--mcp Enable MCP server at /mcp (agent tool surface; pairs with charlie)
3637
-v, --version Print jspod version
3738
--help Show help
3839
```
@@ -48,10 +49,44 @@ jspod install # curated set: chrome vellum w
4849
jspod install JavaScriptSolidServer/git # any GitHub org/repo
4950
jspod install litecut/litecut.github.io=litecut # rename the pod path
5051
jspod install solid-apps/chrome#v1 # pin a branch or tag
52+
jspod install --bundle starter # curated starter set
53+
jspod install --bundle agentic # agent stack (charlie + chat + ...)
54+
jspod install --bundle all # every solid-app
5155
```
5256

5357
Each app lands at `/public/apps/<name>/` and is reachable in the browser immediately. `jspod install --help` for the full spec.
5458

59+
### Available bundles
60+
61+
Curated sets, all maintained at [`solid-apps/bundles`](https://github.com/solid-apps/bundles):
62+
63+
| Bundle | Apps | Use |
64+
|---|---|---|
65+
| `starter` | chrome, vellum, pdf, alarm, chat | Minimal pleasant first-run |
66+
| `all` | every solid-app | Everything in the org |
67+
| `media` | playlist, pdf | Media stack |
68+
| `productivity` | vellum, hub, win98, chat, mindstr, transcribe | Docs + workspace + retro shell + chat + mind mapping + speech-to-text |
69+
| `agentic` | charlie, chat, taskify, vellum, forum, chrome | Run agents on your pod — pairs with `--mcp` |
70+
71+
You can also point at your own bundle URL:
72+
73+
```bash
74+
jspod install --bundle https://my.pod/bundles/dev-stack.jsonld
75+
```
76+
77+
## Run agents
78+
79+
When `--mcp` is enabled, your pod exposes 16 tools at `/mcp` (CRUD, ACL, skills, docs, federation) that any MCP-compatible client — Claude Desktop, Cursor, custom bots — can drive. The natural way to use it from a browser is the bundled chat bot:
80+
81+
```bash
82+
npx jspod --mcp # pod with MCP server enabled
83+
jspod install --bundle agentic # charlie, chat, taskify, vellum, forum, chrome
84+
```
85+
86+
Then open `http://localhost:5444/public/apps/charlie/`, log in via the xlogin button, paste an LLM API key in settings. Charlie reads its persona from `<pod>/SKILL.md`, uses the pod's `/mcp` as its tool surface, and chats with you. Edit `SKILL.md` and the bot's behaviour shifts next session — no retraining, no vendor.
87+
88+
The whole stack — identity, memory, tools, brain — runs on your pod.
89+
5590
## The auth ladder
5691

5792
jspod ships you onto the lowest rung that's safe, and the climb is visible:

0 commit comments

Comments
 (0)