Skip to content

Update README for server secret and tools #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thrr87 merged 1 commit into from
Feb 5, 2026
Merged

Update README for server secret and tools #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

**Documentation:** [openhoard.vercel.app](https://openhoard.vercel.app)

**Versioning note:** The package version (currently 0.1.x, pre‑alpha) is independent from feature milestone labels in this README (e.g., “v0.7” write layer, “v1” security/connectors). Milestones describe maturity of specific subsystems, not a released package version.

---

## Why Hoard
Expand Down Expand Up @@ -60,6 +62,7 @@ hoard search "my notes"
### Recommended setup flow
```bash
hoard init # wizard: choose sources, file types, vectors
export HOARD_SERVER_SECRET=$(python -c "import secrets; print(secrets.token_hex(32))")
hoard serve # start HTTP MCP server (default port 19850)
hoard setup --all # configure Claude Code / Codex / OpenClaw
```
Expand Down Expand Up @@ -130,6 +133,7 @@ hoard embeddings build

### Server
```bash
export HOARD_SERVER_SECRET=$(python -c "import secrets; print(secrets.token_hex(32))")
hoard serve # HTTP MCP server (http://127.0.0.1:19850/mcp)
# SSE events: http://127.0.0.1:19850/events
hoard serve --daemon
Expand All @@ -138,6 +142,12 @@ hoard serve --stop
hoard serve --install-autostart
```

To run in read-only mode without a server secret, set in `~/.hoard/config.yaml`:
```yaml
write:
enabled: false
```

### Optional Dependencies
```bash
pip install -e ".[watcher]" # enable file watcher
Expand Down Expand Up @@ -207,6 +217,16 @@ hoard mcp stdio

---

## Additional MCP Tools

Beyond `search/get/get_chunk/sync`, Hoard exposes tools for:
- Structured memory writes and review (`memory_write`, `memory_propose`, `memory_review`, `memory_supersede`, `memory_retract`)
- Memory conflict/duplicate resolution (`conflicts_list`, `conflict_resolve`, `duplicates_list`, `duplicate_resolve`)
- Agent inbox ingestion (`inbox_put`)
- Orchestration and artifacts (agents, tasks, workflows, events, cost reporting)

---

## Connectors

Enable in `~/.hoard/config.yaml`:
Expand Down