From 19da808c90a7c12ecca9e664e487b98fabee5e41 Mon Sep 17 00:00:00 2001 From: Riz Ashraf Date: Wed, 9 Sep 2026 04:02:39 +0100 Subject: [PATCH] docs: Update docs for dashboard root and API stats --- README.md | 9 +++++++++ design.md | 3 ++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3985da2..dc6c1a6 100644 --- a/README.md +++ b/README.md @@ -66,5 +66,14 @@ mcp-memory gate verify ` This queries the daemon (via HTTP) to confirm if pre-push validation (like running tests via PrePushAuditor) has been cleared by the agent. ` +## Brain Monitor Dashboard +The server hosts a live, real-time HTML dashboard called the **Brain Monitor**. It visually tracks the metrics of your Antigravity knowledge graph, such as the total count of Entities, Relations, Tasks, Snippets, and Architectural Decisions (ADRs). + +To view the dashboard, simply navigate to the root endpoint in your browser while the server is running: +`http://127.0.0.1:3000/` + +You can also programmatically query these live metrics via the API endpoint: +`curl http://127.0.0.1:3000/api/stats` + ## Further Reading For a deep dive into the architecture, Write-Ahead Logging (WAL), locking mechanisms, and the HTTP SSE event loop, consult the design.md file in this repository. diff --git a/design.md b/design.md index 347d220..0c41058 100644 --- a/design.md +++ b/design.md @@ -16,8 +16,9 @@ The daemon uses the `axum` and `rust-mcp-axum` crates, binding to `0.0.0.0:3000` * `POST /messages`: The JSON-RPC endpoint. Clients use this to send tool calls and resource reads up to the server. ### Custom Integration Endpoints +* `GET /`: The Brain Monitor live HTML dashboard (returns real-time metrics UI). +* `GET /api/stats`: Returns a JSON snapshot of current entity, relation, task, and tech debt counts. * `GET /gate/verify`: A lightweight, deterministic endpoint used by external scripts to verify if an action (like a `git push`) is authorized based on the current state. -* *(Future)* `GET /health` or `GET /graph` for immediate system inspection. ## 3. Client Connections The Antigravity configurations (`mcp_config.json`) utilize the dual-transport system: