riz/mcp-memory
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update docs for dashboard root and API stats

Browse Source
This commit is contained in:
Riz Ashraf committed 2026-09-09 04:02:39 +01:00
1 parent 458f4399b3
commit 19da808c90
2 files changed
+11 -1
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+9
View File
@@ -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. 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 ## 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. 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.
design.md
+2 -1
View File
@@ -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. * `POST /messages`: The JSON-RPC endpoint. Clients use this to send tool calls and resource reads up to the server.
### Custom Integration Endpoints ### 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. * `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 ## 3. Client Connections
The Antigravity configurations (`mcp_config.json`) utilize the dual-transport system: The Antigravity configurations (`mcp_config.json`) utilize the dual-transport system: