Skip to content

Commit 6e3217c

Browse files
committed
docs(mcp): simplify README for end users
Remove technical implementation details, use user-friendly language, rename "local mode" to "self-hosted" throughout.
1 parent 8c7c182 commit 6e3217c

File tree

2 files changed

+13
-42
lines changed

2 files changed

+13
-42
lines changed

apps/mcp/README.md

Lines changed: 12 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# @rawcontext/engram-mcp
22

3-
Model Context Protocol (MCP) server providing intelligent, graph-backed memory for AI agents.
3+
Long-term memory for AI agents.
44

55
## Overview
66

7-
Engram MCP enables AI agents to store and retrieve long-term memories across sessions using a bitemporal knowledge graph. It supports cloud-managed and self-hosted deployments with hybrid semantic/keyword search.
7+
Engram gives AI agents persistent memory across sessions. Store decisions, preferences, insights, and context that your AI assistant can recall in future conversations.
88

99
## Installation
1010

@@ -50,9 +50,9 @@ On first run, authenticate via browser (OAuth device flow).
5050

5151
## Modes
5252

53-
**Cloud mode** (default): Managed API with OAuth authentication. Core tools available (`remember`, `recall`).
53+
**Cloud** (default): Managed service with OAuth authentication.
5454

55-
**Local mode**: Self-hosted with full features including resources, prompts, and graph queries. Set `ENGRAM_API_URL=http://localhost:6174` and run infrastructure from the [monorepo](https://github.com/rawcontext/engram).
55+
**Self-hosted**: Full features including resources, prompts, and graph queries. See [Self-Hosting](#self-hosting).
5656

5757
## Tools
5858

@@ -71,14 +71,14 @@ On first run, authenticate via browser (OAuth device flow).
7171
| `extract_facts` | Parse unstructured text into atomic facts |
7272
| `enrich_memory` | Auto-generate summary, keywords, and category for memories |
7373

74-
### Local Mode Tools
74+
### Self-Hosted Tools
7575

7676
| Tool | Description |
7777
|------|-------------|
78-
| `query` | Execute read-only Cypher queries against the knowledge graph |
78+
| `query` | Run custom queries against your memory graph |
7979
| `context` | Assemble comprehensive context (memories + file history + decisions) for tasks |
8080

81-
## Resources (Local Mode)
81+
## Resources (Self-Hosted)
8282

8383
| URI | Description |
8484
|-----|-------------|
@@ -87,7 +87,7 @@ On first run, authenticate via browser (OAuth device flow).
8787
| `session://{id}/summary` | AI-generated session summary |
8888
| `file-history://{path}` | Change history for a file |
8989

90-
## Prompts (Local Mode)
90+
## Prompts (Self-Hosted)
9191

9292
| Prompt | Description |
9393
|--------|-------------|
@@ -99,41 +99,12 @@ On first run, authenticate via browser (OAuth device flow).
9999

100100
| Variable | Default | Description |
101101
|----------|---------|-------------|
102-
| `ENGRAM_API_URL` | `https://api.engram.rawcontext.com` | API URL. Set to `http://localhost:6174` for local mode |
103-
| `ENGRAM_OBSERVATORY_URL` | Auto-detected | Observatory URL for OAuth device flow |
104-
| `MCP_TRANSPORT` | `stdio` | Transport mode (`stdio` or `http`) |
105-
| `MCP_HTTP_PORT` | `3010` | HTTP server port (when using HTTP transport) |
106-
| `LOG_LEVEL` | `info` | Logging level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`) |
102+
| `ENGRAM_API_URL` | Cloud API | Set to `http://localhost:6174` for self-hosted mode |
103+
| `LOG_LEVEL` | `info` | Logging level (`debug`, `info`, `warn`, `error`) |
107104

108-
## Local Development
105+
## Self-Hosting
109106

110-
```bash
111-
# Clone the monorepo
112-
git clone https://github.com/rawcontext/engram.git
113-
cd engram
114-
115-
# Install dependencies
116-
bun install
117-
118-
# Start infrastructure (FalkorDB, Qdrant, NATS, PostgreSQL)
119-
bun run infra:up
120-
121-
# Run MCP server in development mode
122-
cd apps/mcp && bun run dev
123-
124-
# Build for production
125-
bun run build
126-
127-
# Type check and lint
128-
bun run typecheck && bun run lint
129-
```
130-
131-
## Architecture
132-
133-
- **Bitemporal Graph**: FalkorDB with valid time (`vt_start`/`vt_end`) and transaction time (`tt_start`/`tt_end`)
134-
- **Hybrid Search**: Dense embeddings (semantic) + BM25 (keyword) via Qdrant
135-
- **Event Streaming**: NATS JetStream for real-time processing
136-
- **Client Capabilities**: Auto-detects sampling, elicitation, roots, resources, and prompts support
107+
See the [monorepo](https://github.com/rawcontext/engram) for self-hosting instructions.
137108

138109
## License
139110

apps/mcp/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@rawcontext/engram-mcp",
3-
"version": "0.1.3",
3+
"version": "0.1.4",
44
"description": "Engram MCP server - intelligent memory for AI agents",
55
"type": "module",
66
"bin": {

0 commit comments

Comments
 (0)