mirror of
https://github.com/ruvnet/RuView
synced 2026-07-22 17:23:19 +00:00
feat(adr-124/phase5): SENSE-BRIDGE docs batch — README, CHANGELOG, workspace docs
Advances SPARC Phase 5 (Completion) docs gate: landing page, changelog entry,
workspace documentation table row, and user-guide subsection.
tools/ruview-mcp/README.md (NEW, 60 lines):
- npm-rendered landing page for @ruvnet/rvagent
- Quickstart: claude mcp add / npx stdio / HTTP with RVAGENT_HTTP_TOKEN
- Feature matrix: 6 wired tools + next-iter placeholders, transport security
summary (Origin validation → 403, bearer token → 401, 127.0.0.1 bind)
- Schema validation gate + RUVIEW-POLICY default-deny description
- ADR cross-reference table: ADR-124/118/122/115/055
CHANGELOG.md (Unreleased Added bullet):
- SENSE-BRIDGE entry after BFLD bullet; names all 6 wired tools by MCP
tool name, stdio + Streamable HTTP transports, security model, Zod schema
barrel (20 tools + 5 policy), EdgeVitalsMessage Python parity,
93 tests / 7 suites, try-it quickstart command
README.md (Documentation table):
- New row after BFLD row: SENSE-BRIDGE summary with 6 tool names, transport
security summary, ADR-124 link, npx quickstart
docs/user-guide.md (subsection after BFLD):
- ### SENSE-BRIDGE — rvagent MCP server for AI agents (ADR-124)
- Claude Code install command + remote sensing-server variant
- 6-tool markdown table with return shapes
- Streamable HTTP usage block (RVAGENT_HTTP_TOKEN, 403/401 behavior)
- Links to tools/ruview-mcp/README.md, ADR-124, issue #787
Test count: 93/93 PASS (unchanged — docs-only iter). Build: tsc clean.
ACs touched: Phase 5 gate — documentation complete; every wired tool
documented in README, CHANGELOG, workspace docs, and user-guide.
Next iter target: iter 7 — extend scripts/generate-witness-bundle.sh for
npm tarball sha256, run a full witness, then open PR → main.
Co-Authored-By: claude-flow <ruv@ruv.net>
This commit is contained in:
@@ -845,6 +845,39 @@ The `rumqttc 0.24` (`use-rustls`) backend ships behind the `mqtt` feature; `Rumq
|
||||
|
||||
Detailed surface: [`v2/crates/wifi-densepose-bfld/README.md`](../v2/crates/wifi-densepose-bfld/README.md), [`docs/research/BFLD/`](research/BFLD/) (11 files, 13,544 words), [ADR-118 through ADR-123](adr/ADR-118-bfld-beamforming-feedback-layer-for-detection.md).
|
||||
|
||||
### SENSE-BRIDGE — rvagent MCP server for AI agents (ADR-124)
|
||||
|
||||
`@ruvnet/rvagent` is a dual-transport MCP server that makes RuView sensing primitives callable by Claude Code, Cursor, and ruflo swarms without bespoke HTTP client code.
|
||||
|
||||
**Install (Claude Code)**:
|
||||
|
||||
```bash
|
||||
claude mcp add rvagent -- npx @ruvnet/rvagent stdio
|
||||
# With a remote sensing-server:
|
||||
RUVIEW_SENSING_SERVER_URL=http://cognitum-v0:3000 claude mcp add rvagent -- npx @ruvnet/rvagent stdio
|
||||
```
|
||||
|
||||
**Available tools (6 of 20 in v0.1.0)**:
|
||||
|
||||
| Tool | Returns |
|
||||
|------|---------|
|
||||
| `ruview.presence.now` | `present`, `n_persons`, `confidence`, `timestamp_ms` |
|
||||
| `ruview.vitals.get_breathing` | `breathing_rate_bpm` (null if unavailable), `confidence` |
|
||||
| `ruview.vitals.get_heart_rate` | `heartrate_bpm` (null if unavailable), `confidence` |
|
||||
| `ruview.vitals.get_all` | Full `EdgeVitalsMessage` (all vitals in one call) |
|
||||
| `ruview.bfld.last_scan` | `identity_risk_score`, `privacy_class`, `n_frames`, `timestamp_ms` |
|
||||
| `ruview.bfld.subscribe` | `subscription_id`, `expires_at`, `topic` (MQTT wildcard) |
|
||||
|
||||
**Streamable HTTP** (for remote ruflo swarms):
|
||||
|
||||
```bash
|
||||
RVAGENT_HTTP_TOKEN=secret npx @ruvnet/rvagent http --port 3001
|
||||
# POST JSON-RPC to http://127.0.0.1:3001/mcp
|
||||
# Cross-origin requests are rejected with 403; missing/wrong token → 401.
|
||||
```
|
||||
|
||||
Source: [`tools/ruview-mcp/`](../tools/ruview-mcp/README.md). Tracking issue: [#787](https://github.com/ruvnet/RuView/issues/787). Full ADR: [ADR-124](adr/ADR-124-rvagent-mcp-ruvector-npm-integration.md).
|
||||
|
||||
---
|
||||
|
||||
## Web UI
|
||||
|
||||
Reference in New Issue
Block a user