Skip to content

Commit f6d24bb

Browse files
authored
Update README.md
1 parent 2ed15f3 commit f6d24bb

1 file changed

Lines changed: 17 additions & 13 deletions

File tree

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,19 @@ KryptoDB is a graph-based memory server for multi-agent systems, exposing its kn
1616
* **Database & Storage:** Neo4j (Graph Database), Redis (Caching)
1717
* **Security:** AES-256-GCM Envelope Encryption, HMAC indexing, API-key Identity
1818

19-
---
20-
19+
20+
2121
<div align="center">
22-
<video src="https://github.com/HarK-github/KryptoDB/raw/main/resources/demo.mp4" width="100%" controls autoplay loop muted></video>
22+
23+
24+
https://github.com/user-attachments/assets/6dc7dd7b-9795-4dc6-a76c-4cd5302b3ec6
25+
26+
2327
<br />
2428
<img src="./image-1.png?v=1" alt="KryptoDB Web Dashboard" style="max-width: 100%" />
2529
</div>
2630

27-
---
31+
2832

2933
## 🔒 Security Model & Residual Trust
3034

@@ -36,7 +40,7 @@ The system is designed to isolate agents from one another, but heavily relies on
3640
- **Master & Scope Keys:** KEKs are held in memory by the daemon. The host filesystem must aggressively protect `.env` and `synapse-scope-keys.json`.
3741
- **Backend Storage:** Redis and Neo4j hold ciphertexts and perform pre-filtering. Standard network isolation and database ACLs are still required to prevent tampering.
3842

39-
---
43+
4044

4145
## ⬡ Architecture Overview
4246

@@ -51,7 +55,7 @@ KryptoDB operates as an intermediary broker between LLM agents and the encrypted
5155

5256
*Note: Ephemeral clustering (Louvain community detection) can be invoked by setting `mode='global'` on queries, which temporarily projects the graph into Neo4j RAM and instantly destroys it after summarization to protect memory limits.*
5357

54-
---
58+
5559

5660
## 🌟 Key Features
5761

@@ -61,7 +65,7 @@ KryptoDB operates as an intermediary broker between LLM agents and the encrypted
6165
* **Asynchronous Human-in-the-Loop (HITL):** Fully asynchronous, non-blocking FastAPI endpoints for reviewing, approving, or rejecting sensitive agent writes to the graph database.
6266
* **Cryptographic Memory Partitioning:** Strict AES-256-GCM envelope encryption guarantees agents can only traverse and recall nodes within their authorized scopes.
6367

64-
---
68+
6569

6670
## 🚀 Deployment Options
6771

@@ -87,7 +91,7 @@ uvicorn kryptodb.daemon.server:app --host 127.0.0.1 --port 8000
8791
```
8892
*The web UI is now accessible at http://127.0.0.1:8000.*
8993

90-
---
94+
9195

9296
## 🔑 Provision an Agent API Key
9397
Once your deployment is running (via Docker or Python), use the admin key to mint an agent credential:
@@ -141,14 +145,14 @@ args = [
141145
]
142146
```
143147

144-
---
148+
145149

146150
## 🛠 MCP Tools Reference
147151

148152
The primary interface for agents is the MCP tool suite.
149153

150154
| Tool Name | Purpose | Example Payload |
151-
|-----------|---------|-----------------|
155+
| --| | --|
152156
| `session_activate_tool` | Unlocks partition keys for the current session. **Must be called before querying.** | `{"active_partitions": ["research"]}` |
153157
| `propose_fact_tool` | Write a new encrypted fact to a specific scope. | `{"subject": "Project X", "predicate": "relies_on", "obj": "DB1", "scope": "research"}` |
154158
| `query_memory_tool` | Search authorized knowledge. Set `mode='global'` for Louvain clustering. | `{"subject_id": "Project X"}` |
@@ -157,7 +161,7 @@ The primary interface for agents is the MCP tool suite.
157161
| `migrate_legacy_tool` | Convert authorized legacy facts into per-knowledge envelopes. | `{"scopes": ["research"]}` |
158162
| `reclassify_tool` | Re-encrypt a knowledge item under a different active scope. | `{"node_id": "uuid-here", "to_scope": "operations"}` |
159163

160-
---
164+
161165

162166
## 🛡 Production Deployment
163167

@@ -186,10 +190,10 @@ docker run --rm \
186190
```
187191
*(Ensure input and output files are pre-created with `0600` permissions on the host. The CLI writes the new agent key to the output file without printing it to stdout.)*
188192

189-
---
193+
190194
## License
191195
Released under the MIT License.
192196

193-
---
197+
194198
## Contributors
195199
Made with ❤️ by **Harshit Kandpal** - *Creator & Lead Developer*

0 commit comments

Comments
 (0)