frank/ruvnet--RuView
1
0
Fork 0
mirror of https://github.com/ruvnet/RuView synced 2026-07-26 18:01:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(adr-124/phase5): SENSE-BRIDGE docs batch — README, CHANGELOG, workspace docs

Browse Source 
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:
ruv
2026-05-24 22:34:34 -04:00
parent 579e0ce72e
commit 0752bbf9d4
4 changed files with 100 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/ruview-mcp/README.md
+65
View File
@@ -0,0 +1,65 @@
# @ruvnet/rvagent — SENSE-BRIDGE MCP Server
**SENSE-BRIDGE** is a dual-transport [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server that bridges the RuView WiFi-DensePose sensing stack to AI agents (Claude Code, Cursor, ruflo swarms, and any MCP-compatible client).
Install once; AI agents can then call `ruview.presence.now`, `ruview.vitals.get_heart_rate`, `ruview.bfld.last_scan`, and more — without writing HTTP or WebSocket client code.
## Quickstart
```bash
# 1. Add to Claude Code
claude mcp add rvagent -- npx @ruvnet/rvagent stdio
# 2. Or run directly
RUVIEW_SENSING_SERVER_URL=http://cognitum-v0:3000 npx @ruvnet/rvagent stdio
# 3. Streamable HTTP (remote agents, ruflo swarms)
RUVIEW_SENSING_SERVER_URL=http://cognitum-v0:3000 \
RVAGENT_HTTP_TOKEN=your-secret \
npx @ruvnet/rvagent http --port 3001
# POST JSON-RPC to http://127.0.0.1:3001/mcp
```
Requirements: **Node.js >= 20**. The `wifi-densepose-sensing-server` Rust binary must be reachable at `RUVIEW_SENSING_SERVER_URL` (default `http://localhost:3000`).
## Feature matrix
| Tool | Description | ADR |
|------|-------------|-----|
| `ruview.presence.now` | Current occupancy: `present`, `n_persons`, `confidence` | ADR-124 §4.1 |
| `ruview.vitals.get_breathing` | Breathing rate bpm (null if unavailable) | ADR-124 §4.1 |
| `ruview.vitals.get_heart_rate` | Heart rate bpm (null if unavailable) | ADR-124 §4.1 |
| `ruview.vitals.get_all` | Full `EdgeVitalsMessage` surface | ADR-124 §4.1 |
| `ruview.bfld.last_scan` | Latest BFLD scan: `identity_risk_score`, `privacy_class`, `n_frames` | ADR-118/124 |
| `ruview.bfld.subscribe` | Subscribe to `ruview/<node_id>/bfld/*` events for `duration_s` seconds | ADR-122/124 |
| *(next iters)* | `pose.latest`, `primitives.*`, `node.*`, `vector.*`, `policy.*` | ADR-124 §4.1/4.1a |
**Transport security (ADR-124 §6)**:
- **stdio**: process-level isolation — no auth needed for local Claude Code / Cursor.
- **Streamable HTTP** (`POST /mcp`): Origin header validation (cross-origin → 403), optional bearer token (`RVAGENT_HTTP_TOKEN` → 401 on mismatch), binds `127.0.0.1` by default per MCP spec.
**Schema validation**: every tool call runs `zod.safeParse` before dispatch; invalid arguments return `McpError(InvalidParams)` rather than a wrapped string.
**Policy layer** (ADR-124 §4.1a): `ruview.policy.*` tools gate every sensing call — `vitals.*` is default-deny until a policy grant is registered via `npx @ruvnet/rvagent policy grant`. Presence and node-list are allow by default.
## ADR cross-reference
| ADR | Decision |
|-----|----------|
| [ADR-124](../../docs/adr/ADR-124-rvagent-mcp-ruvector-npm-integration.md) | SENSE-BRIDGE: dual-transport MCP server + ruvector npm + ruflo integration |
| [ADR-118](../../docs/adr/ADR-118-bfld-beamforming-feedback-layer-for-detection.md) | BFLD pipeline — source of `bfld.last_scan` wire format |
| [ADR-122](../../docs/adr/ADR-122-bfld-ruview-ha-matter-exposure.md) | MQTT topic routing `ruview/<node_id>/bfld/*` |
| [ADR-115](../../docs/adr/ADR-115-home-assistant-integration.md) | `EdgeVitalsMessage` WebSocket surface (`ws.py:74-88` parity) |
| [ADR-055](../../docs/adr/ADR-055-integrated-sensing-server.md) | Sensing-server REST API (`/api/v1/*`) |
## Development
```bash
cd tools/ruview-mcp
npm install
npm run build # tsc
npm test # jest — 93 tests across 7 suites
```
Source: `tools/ruview-mcp/src/`. Tests: `tools/ruview-mcp/tests/`.
Tracking issue: [#787](https://github.com/ruvnet/RuView/issues/787).