Skip to content

Commit 0312829

Browse files
Clarify README benefits with visuals
1 parent 04f1ea7 commit 0312829

6 files changed

Lines changed: 194 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,32 @@ https://discord.com/invite/Wfr2ejBmY
1010

1111
**Give your AI agents a memory. See it, search it, and maintain it — all in a beautiful WebUI on your own machine.**
1212

13+
## What Engraphis gives an agent
14+
15+
An agent should not have to reconstruct a project from scattered chat history on every task.
16+
Engraphis turns local project knowledge into scoped, time-aware memory; retrieves the evidence
17+
that supports the current question; and returns a bounded, attributable context packet.
18+
19+
<p align="center">
20+
<img src="docs/images/engraphis-benefit-flow.png" alt="Diagram: project history becomes scoped and temporal Engraphis memory, hybrid recall, then bounded cited context for an agent" width="100%">
21+
<br>
22+
<sup>Store durable project knowledge · retrieve supporting evidence · give the agent only what it needs</sup>
23+
</p>
24+
25+
| Agent need | What Engraphis changes |
26+
|---|---|
27+
| Remember a project across sessions | Stores typed memory in a `workspace → repo → session` hierarchy and provides a last-session handoff. |
28+
| Find support for the current task | Fuses vector, lexical, graph, and code-aware retrieval instead of relying on one search signal. |
29+
| Know what is true now—and what changed | Preserves bi-temporal history and supersession chains instead of silently overwriting a fact. |
30+
| Avoid confident guesses | Returns cited evidence or explicitly abstains when support is too weak. |
31+
| Avoid dragging the whole project into every prompt | Packs context to a configured hard budget and can return a compact MCP response. |
32+
| Keep knowledge in the operator's control | Runs local-first and offline-capable, with scopes, audit records, and optional privacy-safe receipts. |
33+
34+
The diagram is the essential path. The sections below cover the dashboard, code graph, local
35+
installation, governance controls, and hosted services in detail. See [measured quality and token
36+
efficiency](#measured-quality-and-token-efficiency) for the current reproducible evidence behind
37+
the context-efficiency claim.
38+
1339
<br>
1440

1541
<p align="center">
@@ -209,6 +235,12 @@ Agents spend less of their context window carrying irrelevant history, leaving m
209235
current task and cited evidence. These are controlled, deterministic fixtures—not model-billing,
210236
task-time, or external benchmark claims.
211237

238+
<p align="center">
239+
<img src="docs/images/context-efficiency.png" alt="Normalized chart: Engraphis retains 27.1 percent of retrieved content, 26.1 percent of the evidence-holding record, and 44.6 percent of the compact MCP response in separate controlled fixtures" width="100%">
240+
<br>
241+
<sup>Each row uses a separate 100% baseline. The measurements have different counting boundaries and are not additive.</sup>
242+
</p>
243+
212244
#### A controlled before-and-after example
213245

214246
| Retrieval mode | Mean returned memory content | Recall@5 |

docs/images/context-efficiency.png

186 KB
Loading

docs/images/context-efficiency.svg

Lines changed: 45 additions & 0 deletions
Loading
221 KB
Loading
Lines changed: 93 additions & 0 deletions
Loading

tests/test_benchmark_evidence.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,30 @@ def test_readme_distinguishes_every_current_token_context_measurement():
5353
assert evidence in readme
5454

5555

56+
def test_readme_makes_agent_benefits_and_visual_evidence_scannable():
57+
"""The public overview and its visual evidence must stay wired to real assets."""
58+
readme = (ROOT / "README.md").read_text(encoding="utf-8")
59+
60+
for evidence in (
61+
"## What Engraphis gives an agent",
62+
"Remember a project across sessions",
63+
"Avoid confident guesses",
64+
"Avoid dragging the whole project into every prompt",
65+
"docs/images/engraphis-benefit-flow.png",
66+
"docs/images/context-efficiency.png",
67+
"Each row uses a separate 100% baseline",
68+
):
69+
assert evidence in readme
70+
71+
for filename in (
72+
"engraphis-benefit-flow.svg",
73+
"engraphis-benefit-flow.png",
74+
"context-efficiency.svg",
75+
"context-efficiency.png",
76+
):
77+
assert (ROOT / "docs" / "images" / filename).is_file()
78+
79+
5680
def _complete_canonical_report(dataset, config):
5781
"""Minimal but fully auditable canonical envelope for validator coverage."""
5882
profile = config["canonical_profile"]

0 commit comments

Comments
 (0)